API Reference

openapi: 3.0.3 info: title: Wire APIs description: APIs for Wires version: '2.0' contact: name: Digital Core @ Jack Henry and Associates, inc. url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: http://jx-r.jhacorp.com description: Corporate Test Server tags: - name: Enterprise Abilities description: Endpoints for getting enterprise wire abilities. - name: Customer Credit Transfers description: APIs for Customer Credit Transfers (pacs.008, pacs.028, pacs.002) - name: Returns description: APIs for Returns (pacs.004, camt.056, camt.029) - name: FI Credit Transfers description: APIs for FI Credit Transfers (pacs.009) - name: Messages List description: APIs for all messages - name: Wires description: API operations in Wire Service - name: Drawdown description: APIs for Drawdown (pain.013, pain.014) - name: Investigations description: APIs for Investigations (camt.110, camt.111) - name: System Messages description: APIs for System Messages (admi.002, admi.007) - name: Draft Wires description: API operations in Wire Draft Service - name: Account Validation description: Account Validation Service API. - name: Customer Account Search description: Account Validation Service API. - name: Entity Search description: Entity API - name: Wire Notifications description: Endpoints for wire notifications. - name: Wire Money Movement Status description: API operations in Money Transfer Service - name: Fedline Direct description: Fedline Direct related APIs - name: Institution Fee Settings description: API operations to add, modify, delete and get Fee records at Institution. - name: Symitar FI Configuration Settings description: Symx Abstraction Service API - name: Symitar FI Transaction Settings description: Symx Abstraction Service API - name: Silverlake FI Settings description: Silverlake Abstraction Service API - name: Incoming wire file description: API operations in the Incoming Wire Processing Service - name: Wire Settings description: API operations in Wire Settings Service - name: Consumer Wire Credit Transfers description: (Feature under construction) APIs for Consumer Credit Transfers (pain.001) paths: /a/api/jh-wires/v2/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/abilities: get: operationId: GetEnterpriseAbilities tags: - Enterprise Abilities summary: Get enterprise user abilities description: Method to get enterprise user abilities. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Abilities retrieved successfully. content: application/json: schema: type: object required: - viewWires - addWire - debtorApprove - creditorApprove - creditorReject - debtorReject - nsfOverride - feeControl - wiresAdmin - drafts - viewDraft - manageDrafts - notifications - ofac - wireFile - createWireLimit - debtorLimit - viewReports properties: viewWires: type: boolean description: Ability to view wire list and details. addWire: type: boolean description: Ability to add wire. debtorApprove: type: boolean description: Ability to approve as debtor. creditorApprove: type: boolean description: Ability to approve as creditor. creditorReject: type: boolean description: Ability to reject as creditor. debtorReject: type: boolean description: Ability to reject as debtor. nsfOverride: type: boolean description: Ability to override NSF. feeControl: type: boolean description: Ability to control fees. wiresAdmin: type: boolean description: Ability to be a wires admin. drafts: type: boolean description: Ability to manage draft activity. viewDraft: type: boolean description: Ability to view draft activity. manageDrafts: type: boolean description: Ability to manage draft activity. notifications: type: boolean description: Ability to manage notification settings. ofac: type: boolean description: Ability to manage OFAC. wireFile: type: boolean description: Ability to manage wire files. createWireLimit: type: object description: The create wire limit. required: - value - currencyType properties: value: type: string description: The value of the currency. example: '1000.00' currencyType: type: string description: The type of currency. example: USD debtorLimit: type: object description: The debtor limit. required: - value - currencyType properties: value: type: string description: The value of the currency. example: '1000.00' currencyType: type: string description: The type of currency. example: USD viewReports: type: boolean description: Ability to view reports. '500': description: Internal server error. /a/api/jh-wires/v2/{InstitutionUniversalId}/customer/credit-transfer: post: deprecated: true operationId: AddCustomerWire tags: - Customer Credit Transfers summary: API to send customer credit transfer wire (pacs.008) (to be retired). description: API to send customer credit transfer wire (pacs.008) (to be retired). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The wire record to be created. content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - agent - name - postalAddress debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. this defaults to creditor agent if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description required: - amount - creditor - debtor responses: '201': description: Created content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v3/{InstitutionUniversalId}/customer/credit-transfer: post: operationId: AddCustomerWire1 tags: - Customer Credit Transfers summary: API to send customer credit transfer wire (pacs.008). description: API to send customer credit transfer wire (pacs.008). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The wire record to be created. content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - agent - name - postalAddress debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - amount - creditor - debtor - instructedAgent responses: '201': description: Created content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fi/credit-transfer: post: deprecated: true operationId: AddFIWire tags: - FI Credit Transfers summary: API to send a wire (pacs.009) (to be retired). description: API to send a wire (pacs.009) (to be retired). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The wire record to be created. content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. this defaults to creditor institution if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: The Local Instrument Proprietary Code can accept either BTRC or BTRD from the user. If the user does not specify a value, the system defaults to BTRC. For BTRC, a new UETR is generated by the system. For BTRD, the UETR from the original drawdown (PAIN.013) is required. wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information required: - amount - creditor - debtor responses: '201': description: Created content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/payment-return/{messageId}: post: operationId: ReturnWire tags: - Returns summary: API to return a wire (pacs.004). description: API to return a wire (pacs.004). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: description: The wire record to be created. content: application/json: schema: type: object properties: returnReason: type: object properties: reasonCode: type: string format: string minLength: 1 maxLength: 4 enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: Return reason code should contain four alphanumeric character code from the ISO 20022 externalized ReturnReason1Code list additionalInfo: type: array items: type: string format: string minLength: 1 maxLength: 105 maxItems: 2 description: Further details on the return reason. required: - reasonCode glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - returnReason responses: '200': description: Returned content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v3/{InstitutionUniversalId}/fi/credit-transfer: post: operationId: AddFIWire1 tags: - FI Credit Transfers summary: API to send a wire (pacs.009). description: API to send a wire (pacs.009). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The wire record to be created. content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: The Local Instrument Proprietary Code can accept either BTRC or BTRD from the user. If the user does not specify a value, the system defaults to BTRC. For BTRC, a new UETR is generated by the system. For BTRD, the UETR from the original drawdown (PAIN.013) is required. wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - amount - creditor - debtor - instructedAgent responses: '201': description: Created content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v3/{InstitutionUniversalId}/payment-return/{messageId}: post: operationId: ReturnWire1 tags: - Returns summary: API to return a wire (pacs.004). description: API to return a wire (pacs.004). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: description: The wire record to be returned. required: true content: application/json: schema: type: object properties: returnReason: type: object properties: reasonCode: type: string format: string minLength: 1 maxLength: 4 enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: Return reason code should contain four alphanumeric character code from the ISO 20022 externalized ReturnReason1Code list additionalInfo: type: array items: type: string format: string minLength: 1 maxLength: 105 maxItems: 2 description: Further details on the return reason. required: - reasonCode glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - returnReason responses: '200': description: Returned content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/details/{messageId}: get: deprecated: true operationId: ViewWireDetails tags: - Customer Credit Transfers summary: API to retrieve a Wire record with wire identifier (pacs.008, pacs.009, pacs.004) (to be retired). description: Method to retrieve Wire information by wire identifier (pacs.008, pacs.009, pacs.004) (to be retired). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Success content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD nullable: false nullable: false approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer returned enum values are CRED, DEBT, SHAR, SLEV nullable: true creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline messageIdentifier: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentifier: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: nullable: false type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory sentOn: type: string format: date-time description: Sent On ISO date format. status: type: string format: string enum: - Processing - Complete - Rejected sanctionIds: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description wireDestination: type: string description: Wire Destination wireSource: type: string description: Wire Source wireId: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing supplementary: type: array items: type: object properties: key: type: string format: string value: type: string format: string createdBy: nullable: false type: string description: User who created the wire createdOn: nullable: false type: string format: date-time description: Created On ISO date format. steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/wires/list: get: deprecated: true operationId: WiresList tags: - Messages List summary: API to retrieve all Wires (to be retired). description: Method to retrieve all wires (to be retired). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: uetr in: query required: false description: filter by UETR or prefix of a UETR schema: type: string format: string example: 123e4567-e89b-12d3-a456-426614174000 - name: startDate in: query required: false description: filter wires by date created on or after the provided value. schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false description: filter wires by date created on or before the provided value. schema: type: string format: date example: '2025-01-01' - name: startAmount in: query required: false description: filter wires by amount >= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: endAmount in: query required: false description: filter wires by amount <= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: accountValidation in: query description: filter wires by the AccountValidation step status required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Canceled - Bypassed - name: approvals in: query description: filter wires by the Approvals step status required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Canceled - Bypassed - name: fedSend in: query description: filter wires by the FedSend step status required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Canceled - Bypassed - name: moneyMovement in: query description: filter wires by the MoneyMovement step status required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Canceled - Bypassed - name: ofac in: query description: filter wires by the Ofac step status required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Canceled - Bypassed - name: status in: query description: query to filter wires by Status required: false schema: type: string format: string enum: - Processing - Complete - Rejected - name: search in: query description: filter wires by performing a full-text search across various fields. required: false schema: type: string example: john+doe - name: authType in: query description: | Filter by auth type. schema: type: string format: string responses: '200': description: Success content: application/json: schema: type: object properties: wires: type: array items: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD nullable: false nullable: false approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer returned enum values are CRED, DEBT, SHAR, SLEV nullable: true creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline messageIdentifier: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentifier: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: nullable: false type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory sentOn: type: string format: date-time description: Sent On ISO date format. status: type: string format: string enum: - Processing - Complete - Rejected sanctionIds: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description wireDestination: type: string description: Wire Destination wireSource: type: string description: Wire Source wireId: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing supplementary: type: array items: type: object properties: key: type: string format: string value: type: string format: string createdBy: nullable: false type: string description: User who created the wire createdOn: nullable: false type: string format: date-time description: Created On ISO date format. steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/retry-failed-steps/{messageId}: post: operationId: RetrySteps tags: - Wires summary: API to retry steps for a wire. description: Method to retry steps for a wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Ok content: application/json: schema: type: object properties: message: type: string format: string description: Message example: Wire successfully queued to retry failed steps processing. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{UETR}: get: deprecated: true operationId: MessagesByUETR tags: - Wires summary: API retrieve messages by uetr attribute. description: Retrieve messages by a common uetr attribute on the message. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: Ok content: application/json: schema: type: array items: type: object properties: messageId: type: string format: uuid description: Unique Message identifier status: type: string format: string enum: - Processing - Success - Failed transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object properties: accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{MessageId}/ofac: post: operationId: Request Screening tags: - Wires summary: API to retry OFAC for a message. description: Method to retry OFAC step for a message. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Ok content: application/json: schema: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ultimateDebitor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ultimateCreditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 initiatingParty: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages: get: operationId: MessageList tags: - Messages List summary: API to retrieve all Messages. description: Method to retrieve all messages. By default, returns JSON. Use the header "Accept" = "text/csv" to request CSV. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: MessageId in: query description: A unique identifier to identify a message (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: query description: Universally unique identifier to provide an end-to-end reference of a payment transaction (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: startDate in: query required: false description: filter wires by date created on or after the provided value. schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false description: filter wires by date created on or before the provided value. schema: type: string format: date example: '2025-01-01' - name: startAmount in: query required: false description: filter wires by amount >= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: endAmount in: query required: false description: filter wires by amount <= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: accountValidation in: query description: filter wires by the AccountValidation step status required: false schema: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed - name: approvals in: query description: filter wires by the Approvals step status required: false schema: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed - name: fedSend in: query description: filter wires by the FedSend step status required: false schema: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed - name: moneyMovement in: query description: filter wires by the MoneyMovement step status required: false schema: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed - name: ofac in: query description: filter wires by the Ofac step status required: false schema: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed - name: status in: query description: query to filter wires by Status required: false schema: type: string format: string enum: - Processing - Complete - Rejected - name: search in: query description: filter wires by performing a full-text search across various fields. required: false schema: type: string example: john+doe - name: businessDefinition in: query description: | Business Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.001.001.12 - consumer transfer request 5. pain.013.001.07 - drawdown request 6. pain.014.001.07 - drawdown response 7. camt.056.001.08 - return request 8. camt.029.001.09 - return response 9. camt.110.001.01 - investigation request 10. cam.111.001.01 - investigation response 11. pacs.028.001.03 - payment status request 12. pacs.002.001.10 - payment status 13. admi.002.001.01 - message rejection 14. admi.007.001.01 - message acknowledgement 15. admi.004.001.02 - ping or broadcast 16. admi.006.001.01 - retrieval request 17. admi.011.001.01 - system response 18. camt.052.001.08 - account reporting 19. camt.060.001.05 - reporting request schema: type: array maxItems: 6 items: type: string format: string enum: - customer transfer - fi transfer - payment return - customer transfer request - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - reporting request - name: transactionType in: query description: | Transaction Type 1. "Outgoing" 2. "Incoming" schema: type: string format: string enum: - Outgoing - Incoming - name: authType in: query description: | Filter by auth type. schema: type: string format: string - name: Accept in: header description: The request header indicating the desired response format. required: false schema: type: string enum: - application/json - text/csv default: application/json - name: messageIdentification in: query description: Fedwire Funds Input Message Accountability Data (IMAD) (as a query parameter). schema: type: string example: 20250814ABCDEFGH000018 - name: businessMessageIdentification in: query description: Output Message Accountability Data (OMAD) (as a query parameter). schema: type: string example: 20250814ABCDEFGH000020 - name: overDirectLine in: query description: Indicates whether the message is sent over a direct line. schema: type: boolean example: true responses: '200': description: Success content: application/json: schema: type: object properties: messages: type: array items: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false messageIdentification: type: string format: string minLength: 1 maxLength: 35 description: Message Identification businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). overDirectLine: type: boolean format: boolean description: Indicates whether the message is sent over a direct line. example: true steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return required: - approvalId - uetr - messageId - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination text/csv: schema: type: string example: |- MessageId,InstructionId,UETR,ApprovalId,Amount,Status,MessageDefinition,BusinessDefinition,TransactionType,CreatedBy,CreatedOn,Steps,Actions MSG123,INST123,550e8400-e29b-41d4-a716-446655440000,APPROVAL123,1000.00,ACCP,Pain.013,TypeA,Type1,user1,2023-10-01T12:00:00Z,"[{"step":"Initiated","timestamp":"2023-10-01T12:00:00Z"}]","[{"action":"Approved","timestamp":"2023-10-01T12:05:00Z"}]" MSG124,INST124,550e8400-e29b-41d4-a716-446655440001,APPROVAL124,2000.00,RJCT,Pain.014,TypeB,Type2,user2,2023-10-02T13:00:00Z,"[{"step":"Initiated","timestamp":"2023-10-02T13:00:00Z"}]","[{"action":"Rejected","timestamp":"2023-10-02T13:05:00Z"}]" description: CSV formatted string of message list '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/drawdown-request: post: operationId: AddDrawDownRequest tags: - Drawdown summary: API to send a draw down request (pain.013). description: API to send a draw down request (pain.013). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The message record to be created. content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - account paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - DRRB - DRRC description: Local Instrument Proprietary Code allowed to accept DRRB, DRRC from user, If user didnot provide, system default to DRRB remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory requestedExecutionDate: type: string format: date description: The requested execution date of the wire transfer. The date must be in the format YYYY-MM-DD. wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description initiatingParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress description: This field will be populated with Creditor information when the Initiating Party is not provided in the pain.013 message. required: - amount - creditor - debtor responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/drawdown-response/{messageId}: post: operationId: SendDrawDownResponse tags: - Drawdown summary: API to send a draw down response (pain.014). description: API to send a draw down response (pain.014). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true description: The message record to be created. content: application/json: schema: type: object properties: transactionStatus: type: string format: string enum: - PDNG - RJCT - ACTC description: | The status of the transaction. This code indicates the current status of the transaction. statusReasonInformation: type: array items: type: object properties: reasonCode: type: string format: string enum: - AB01 - AB02 - AB03 - AB04 - AB05 - AB06 - AB07 - AB08 - AB09 - AB10 - AB11 - AC01 - AC02 - AC03 - AC04 - AC05 - AC06 - AC07 - AC08 - AC09 - AC10 - AC11 - AC12 - AC13 - AC14 - AC15 - AC16 - AG01 - AG02 - AG03 - AG04 - AG05 - AG06 - AG07 - AG08 - AG09 - AG10 - AG11 - AG12 - AG13 - AGNT - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - AM11 - AM12 - AM13 - AM14 - AM15 - AM16 - AM17 - AM18 - AM19 - AM20 - AM21 - AM22 - AM23 - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - BE09 - BE10 - BE11 - BE12 - BE13 - BE14 - BE15 - BE16 - BE17 - BE18 - BE19 - BE20 - BE21 - BE22 - BE23 - CERI - CH03 - CH04 - CH07 - CH09 - CH10 - CH11 - CH12 - CH13 - CH14 - CH15 - CH16 - CH17 - CH19 - CH20 - CH21 - CH22 - CHQC - CNOR - CURR - CUST - DNOR - DS01 - DS02 - DS03 - DS04 - DS05 - DS06 - DS07 - DS08 - DS09 - DS0A - DS0B - DS0C - DS0D - DS0E - DS0F - DS0G - DS0H - DS0K - DS10 - DS11 - DS12 - DS13 - DS14 - DS15 - DS16 - DS17 - DS18 - DS19 - DS20 - DS21 - DS22 - DS23 - DS24 - DS25 - DS26 - DS27 - DT01 - DT02 - DT03 - DT04 - DT05 - DT06 - DU01 - DU02 - DU03 - DU04 - DU05 - DUPL - ED01 - ED03 - ED05 - ED06 - ERIN - FF01 - FF02 - FF03 - FF04 - FF05 - FF06 - FF07 - FF08 - FF09 - FF10 - FF11 - G000 - G001 - G002 - G003 - G004 - G005 - G006 - ID01 - MD01 - MD02 - MD05 - MD06 - MD07 - MS02 - MS03 - NARR - NERI - RC01 - RC02 - RC03 - RC04 - RC05 - RC06 - RC07 - RC08 - RC09 - RC10 - RC11 - RC12 - RCON - RECI - RF01 - RR01 - RR02 - RR03 - RR04 - RR05 - RR06 - RR07 - RR08 - RR09 - RR10 - RR11 - RR12 - S000 - S001 - S002 - S003 - S004 - SL01 - SL02 - SL03 - SL11 - SL12 - SL13 - SL14 - TA01 - TD01 - TD02 - TD03 - TK01 - TK02 - TK03 - TK09 - TKCM - TKSG - TKSP - TKVE - TKXP - TM01 - TS01 - TS04 - CN01 - FOCR - FR01 - NOCM - NOAS - RUTA - UPAY - ALAC - AEXR - ARFR - ARJR - ATNS - EDTR - EDTL - FRAD - IEDT - IRNR - NOAR - NOPG - NRCH - RTNS - REPR - SPII - PINS - UCRD - FF12 - FF13 - DC02 - APAR description: | status reason codes should contain a code from the ISO 20022 externalized StatusReason1Code code list. example: AB01 proprietary: type: string format: string maxLength: 35 description: Proprietary code for the reason of the drawdown response. additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the drawdown response. required: - reasonCode - proprietary description: | The status reason information is required when the transaction status is RJCT(Rejected). The reason code and proprietary information provide details about the rejection. required: - transactionStatus responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/return-request/{messageId}: post: operationId: AddCamt56ReturnRequest tags: - Returns summary: API to send a return request of a wire transfer (camt.056). description: API to send a return request of a wire transfer (camt.056). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true description: The message record to be created. content: application/json: schema: oneOf: - type: object properties: caseId: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: description: The creator party is the person or organization that created the investigation case type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress cancellationReason: description: | The cancellation reason is the reason for the return request. If the reason code for a return request is 'NARR' (Narrative), then additionalInfo is mandatory. type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode required: - cancellationReason - creatorParty - type: object properties: caseId: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorAgent: description: | The creator agent is the financial institution that created return request. user can input name and postal address or system autofill based on the financial institution memberId. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution cancellationReason: description: | The cancellation reason is the reason for the return request. If the reason code for a return request is 'NARR' (Narrative), then additionalInfo is mandatory. type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode required: - cancellationReason - creatorAgent responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/return-response/{messageId}: post: operationId: AddCamt29Request tags: - Returns summary: API to send a response of a return request for a wire transfer (camt.029). description: API to send a response of a return request for a wire transfer (camt.029). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true description: The message record to be created. content: application/json: schema: type: object properties: cancellationReason: type: object properties: reasonCode: type: string format: string enum: - AC04 - ADAC - AGNT - AM04 - ARDT - ARPL - CUST - LEGL - NARR - NOAS - NOOR - PTNA - RQDA - WSEQ - IDMN - ACLR - AEXR - ARFR - ARJR - PATE - RR04 - RCAR - RCNR - RCPR - URTP description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC04 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode status: type: string format: string enum: - CNCL - RJCR required: - status responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/investigation-request/{messageId}: post: operationId: AddInvestigationRequest tags: - Investigations summary: API to create an investigation request for a wire (camt.110). description: Method to create an investigation request for a wire transfer (camt.110). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true description: The investigation request payload. content: application/json: schema: type: object properties: requestorInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 investigationType: type: string format: string enum: - UTAP - CCNR - CONR - RQFI - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF - OTHR description: | Investigation type codes should contain a code from the ISO 20022 externalized InvestigationType1Code code list. example: UTAP responderAgent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution investigationData: type: array minItems: 1 items: type: object properties: reasonCode: type: string format: string enum: - RERE - SVLV - CAPU - REDT - ISDT - ISAM - AMNT - DTOR - DTAG - IGRA - IDRA - TDRA - INAG - PYCC - CTAG - CTOR - REIN - PYPU - CHBE - INNA - INCA - STET - SEAC - CHIN - ULTD - ULTC - PURP - INPA - REGR - TAXD - FRAD - FCCI - FWTR - CHCO - DRCO - AMLI - RQPR - RQVD - RQLD - RQSG - RQED - RQDO - CHNP - NARR - RQCD - UTAP - CCNR - CONR - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF description: | Reason codes should contain a code from the ISO 20022 externalized InvestigationReason1Code code list. example: RERE narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). required: - investigationType - responderAgent - investigationData responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/investigation-response/{messageId}: post: operationId: AddInvestigationResponse tags: - Investigations summary: API to create an investigation response for a wire (camt.111). description: Method to create an investigation response for a wire (camt.110). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true description: The investigation response payload. content: application/json: schema: type: object properties: responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 investigationStatus: type: string format: string enum: - PDNG - RJCT - CLSD description: | The status of the investigation. This code indicates the current status of the investigation. investigationStatusReason: type: string format: string enum: - AGNT - DU01 - NARR - FTNA - CAPR - CACR - ADAC - ARPL - NOAS - INPO - NOOR - ARJT - ARDT - RR04 - LEGL - ESCA - INIT - PARE - NOAD description: | Status reason codes should contain a code from the ISO 20022 externalized InvestigationStatusReason1Code code list. example: AGNT investigationData: type: array minItems: 1 items: type: object properties: narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). required: - investigationStatus - investigationStatusReason - investigationData responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/drawdown-request/{messageId}: get: operationId: GetDrawDownRequest tags: - Drawdown summary: API to get a draw down request by messageId (pain.013) description: API to ge a draw down request by messageId (pain.013) parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: Draw down message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress initiatingParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress description: This is the person/entity that initiated the request for payment (pain.013). creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution paymentInformationIdentification: type: string format: string maxLength: 35 description: Payment information identification. requestExecutionTime: type: string format: date-time description: | The time at which the request was executed. This is the timestamp of when the request was processed. example: '2025-01-01T12:00:00Z' paymentMethod: type: string format: string enum: - TRF description: | The payment method used for the transaction. This code indicates the type of payment method used for the transaction. example: TRF paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - DRRB - DRRC description: Local Instrument Proprietary Code allowed to accept DRRB, DRRC from user, If user didnot provide, system default to DRRB chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - creditor - debtor - initiatingParty - creditorAgent - debtorAgent - paymentInformationIdentification - requestExecutionTime - paymentMethod - paymentIdentification - paymentTypeInformation - chargeBearer - fedMessage - sanctionReference description: | The Pain013 message is used to provide information about the drawdown requested. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/drawdown-response/{messageId}: get: operationId: GetDrawDownResponse tags: - Drawdown summary: API to get a draw down response by messageId (pain.014) description: API to ge a draw down response by messageId (pain.014) parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: Draw down response message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' initiatingParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress description: This is the person/entity that initiated the request for payment (pain.013). creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalBusinessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' paymentInformationIdentification: type: string format: string maxLength: 35 description: Payment information identification. transactionStatus: type: string format: string enum: - PDNG - RJCT - ACTC description: | The status of the transaction. This code indicates the current status of the transaction. transactionStatusReasonInformation: type: array items: type: object properties: reasonCode: type: string format: string enum: - AB01 - AB02 - AB03 - AB04 - AB05 - AB06 - AB07 - AB08 - AB09 - AB10 - AB11 - AC01 - AC02 - AC03 - AC04 - AC05 - AC06 - AC07 - AC08 - AC09 - AC10 - AC11 - AC12 - AC13 - AC14 - AC15 - AC16 - AG01 - AG02 - AG03 - AG04 - AG05 - AG06 - AG07 - AG08 - AG09 - AG10 - AG11 - AG12 - AG13 - AGNT - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - AM11 - AM12 - AM13 - AM14 - AM15 - AM16 - AM17 - AM18 - AM19 - AM20 - AM21 - AM22 - AM23 - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - BE09 - BE10 - BE11 - BE12 - BE13 - BE14 - BE15 - BE16 - BE17 - BE18 - BE19 - BE20 - BE21 - BE22 - BE23 - CERI - CH03 - CH04 - CH07 - CH09 - CH10 - CH11 - CH12 - CH13 - CH14 - CH15 - CH16 - CH17 - CH19 - CH20 - CH21 - CH22 - CHQC - CNOR - CURR - CUST - DNOR - DS01 - DS02 - DS03 - DS04 - DS05 - DS06 - DS07 - DS08 - DS09 - DS0A - DS0B - DS0C - DS0D - DS0E - DS0F - DS0G - DS0H - DS0K - DS10 - DS11 - DS12 - DS13 - DS14 - DS15 - DS16 - DS17 - DS18 - DS19 - DS20 - DS21 - DS22 - DS23 - DS24 - DS25 - DS26 - DS27 - DT01 - DT02 - DT03 - DT04 - DT05 - DT06 - DU01 - DU02 - DU03 - DU04 - DU05 - DUPL - ED01 - ED03 - ED05 - ED06 - ERIN - FF01 - FF02 - FF03 - FF04 - FF05 - FF06 - FF07 - FF08 - FF09 - FF10 - FF11 - G000 - G001 - G002 - G003 - G004 - G005 - G006 - ID01 - MD01 - MD02 - MD05 - MD06 - MD07 - MS02 - MS03 - NARR - NERI - RC01 - RC02 - RC03 - RC04 - RC05 - RC06 - RC07 - RC08 - RC09 - RC10 - RC11 - RC12 - RCON - RECI - RF01 - RR01 - RR02 - RR03 - RR04 - RR05 - RR06 - RR07 - RR08 - RR09 - RR10 - RR11 - RR12 - S000 - S001 - S002 - S003 - S004 - SL01 - SL02 - SL03 - SL11 - SL12 - SL13 - SL14 - TA01 - TD01 - TD02 - TD03 - TK01 - TK02 - TK03 - TK09 - TKCM - TKSG - TKSP - TKVE - TKXP - TM01 - TS01 - TS04 - CN01 - FOCR - FR01 - NOCM - NOAS - RUTA - UPAY - ALAC - AEXR - ARFR - ARJR - ATNS - EDTR - EDTL - FRAD - IEDT - IRNR - NOAR - NOPG - NRCH - RTNS - REPR - SPII - PINS - UCRD - FF12 - FF13 - DC02 - APAR description: | status reason codes should contain a code from the ISO 20022 externalized StatusReason1Code code list. example: AB01 proprietary: type: string format: string maxLength: 35 description: Proprietary code for the reason of the drawdown response. additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the drawdown response. required: - reasonCode - proprietary sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - initiatingParty - creditorAgent - debtorAgent - originalMessageIdentification - originalMessageDefinition - originalBusinessDefinition - originalSentOn - paymentInformationIdentification - transactionStatus - transactionStatusReasonInformation - fedMessage - sanctionReference description: | The Pain014 message is used to provide information about response of pain.013 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/request-return/{messageId}: get: operationId: GetReturnRequest tags: - Returns summary: API to get a return request by messageId (camt.056). description: API to ge a return request by messageId (camt.056). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: return request message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' assignerAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution assigneeAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution caseIdentification: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress creatorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress originalInterbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true cancellationReason: type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the request return response. required: - reasonCode fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: caseCreatorAgent: type: string format: uuid description: Reference to the case creator agent. caseCreatorEntity: type: string format: uuid description: Reference to the case creator party. originator: type: string format: uuid description: Reference to the originator. oneOf: - required: - caseCreatorAgent - required: - caseCreatorEntity required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - originalMessageIdentification - originalMessageDefinition - originalSentOn - assignerAgent - assigneeAgent - caseIdentification - creatorParty - creatorAgent - originalInterbankSettlementDate - cancellationReason - fedMessage - sanctionReference '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/return-response/{messageId}: get: operationId: GetReturnResponse tags: - Returns summary: API to get a return response by messageId (camt.029). description: API to ge a return response by messageId (camt.029). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: return response message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. assignerAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution assigneeAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' resolvedCaseIdentification: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress creatorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress statusConfirmation: type: string format: string enum: - CNCL - RJCR - PDCR - PECR description: | The status of the transaction. This code indicates the current status of the transaction. cancellationReason: type: array items: type: object properties: reasonCode: type: string format: string enum: - AC04 - ADAC - AGNT - AM04 - ARDT - ARPL - CUST - LEGL - NARR - NOAS - NOOR - PTNA - RQDA - WSEQ - IDMN - ACLR - AEXR - ARFR - ARJR - PATE - RR04 - RCAR - RCNR - RCPR - URTP description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC04 proprietary: type: string format: string maxLength: 35 description: Proprietary code for the status reason. additionalInformation: type: string format: string maxLength: 105 description: Further details on the status reason. required: - reasonCode - proprietary - additionalInformation description: | If the reason code for a return request response is 'NARR' (Narrative), then the free-formatted reason must be provided in Additional Information. sanctionReference: type: object properties: caseCreatorAgent: type: string format: uuid description: Reference to the case creator agent. caseCreatorEntity: type: string format: uuid description: Reference to the case creator party. originator: type: string format: uuid description: Reference to the originator. required: - originator required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - fedMessage - assignerAgent - assigneeAgent - originalMessageIdentification - originalMessageDefinition - originalSentOn - resolvedCaseIdentification - creatorParty - creatorAgent - statusConfirmation - cancellationReason - sanctionReference '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/investigation-request/{messageId}: get: operationId: GetInvestigationRequest tags: - Investigations summary: API to get a investigation request by messageId0 (camt.110). description: API to ge a investigation request by messageId (camt.110). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: investigation request message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. investigationType: type: string format: string enum: - UTAP - CCNR - CONR - RQFI - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF - OTHR description: | Investigation type codes should contain a code from the ISO 20022 externalized InvestigationType1Code code list. example: UTAP requestorInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 requestorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution responderAgent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution investigationData: type: array minItems: 1 items: type: object properties: reasonCode: type: string format: string enum: - RERE - SVLV - CAPU - REDT - ISDT - ISAM - AMNT - DTOR - DTAG - IGRA - IDRA - TDRA - INAG - PYCC - CTAG - CTOR - REIN - PYPU - CHBE - INNA - INCA - STET - SEAC - CHIN - ULTD - ULTC - PURP - INPA - REGR - TAXD - FRAD - FCCI - FWTR - CHCO - DRCO - AMLI - RQPR - RQVD - RQLD - RQSG - RQED - RQDO - CHNP - NARR - RQCD - UTAP - CCNR - CONR - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF description: | Reason codes should contain a code from the ISO 20022 externalized InvestigationReason1Code code list. example: RERE narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). initiation: type: object properties: originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalUetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. originalInstructedAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' requestExecutionTime: type: string format: date-time description: | The time at which the request was executed. This is the timestamp of when the request was processed. example: '2025-01-01T12:00:00Z' required: - originalMessageIdentification - originalMessageDefinition - originalSentOn - originalUetr - requestExecutionTime interbank: type: object properties: originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalInterbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true originalInterbankSettlementAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' required: - originalMessageIdentification - originalMessageDefinition - originalSentOn required: - messageId - instructionId - uetr - approvalId - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - sentOn - fedMessage - investigationType - requestorAgent - responderAgent - investigationData - initiation - interbank '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/investigation-response/{messageId}: get: operationId: GetInvestigationResponse tags: - Investigations summary: API to get a investigation response by messageId (camt.111). description: API to ge a investigation response by messageId (camt.111). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: investigation response message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). investigationType: type: string format: string enum: - UTAP - CCNR - CONR - RQFI - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF - OTHR description: | Investigation type codes should contain a code from the ISO 20022 externalized InvestigationType1Code code list. example: UTAP responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 investigationStatus: type: string format: string enum: - PDNG - RJCT - CLSD description: | The status of the investigation. This code indicates the current status of the investigation. investigationStatusReason: type: string format: string enum: - AGNT - DU01 - NARR - FTNA - CAPR - CACR - ADAC - ARPL - NOAS - INPO - NOOR - ARJT - ARDT - RR04 - LEGL - ESCA - INIT - PARE - NOAD description: | Status reason codes should contain a code from the ISO 20022 externalized InvestigationStatusReason1Code code list. example: AGNT investigationData: type: array minItems: 1 items: type: object properties: narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). requestorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution responderAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - sentOn - fedMessage - originalMessageIdentification - investigationType - responderInvestigationId - investigationStatus - requestorAgent - responderAgent '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/request-payment-status/{messageId}: post: operationId: Add Payment status Request tags: - Customer Credit Transfers summary: API for sending FI to FI Payment Status Request (pacs.028). description: API for sending FI to FI Payment Status Request (pacs.028). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/request-payment-status/{messageId}: get: operationId: GetPaymentStatusRequest tags: - Customer Credit Transfers summary: API to get a payment status request by messageId (pacs.028). description: API to ge a payment status request by messageId (pacs.028). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: payment status message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - fedMessage - originalMessageIdentification - originalMessageDefinition - originalSentOn - instructedAgent - instructingAgent '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/payment-status/{messageId}: get: operationId: GetPaymenStatus tags: - Customer Credit Transfers summary: API to get a payment status by messageId (pacs.002). description: API to ge a payment status by messageId (pacs.002). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: payment status message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 1 maxLength: 35 description: Message Identification businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution transactionStatus: type: string format: string enum: - ACSC - PDNG - RJCT description: | If a transaction is successfully settled(ACSC), then Acceptance Date Time and Effective Interbank Settlement Date mandatory. If a transaction is pending or is rejected then the status reason information(s) mandatory. statusReasonInformation: type: array items: type: object properties: proprietary: type: string format: string maxLength: 35 description: Proprietary code for the status reason. additionalInformation: type: string format: string maxLength: 105 description: Further details on the status reason. required: - proprietary - additionalInformation description: | The status reason for the transaction. If a transaction is pending(PDNG) or is rejected(RJCT) then the reason(s) mandatory. acceptanceDateTime: type: string format: date-time description: | The date and time at which the transaction was accepted. This is the timestamp of when the transaction was accepted. example: '2025-01-01T12:00:00Z' interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - fedMessage - originalMessageIdentification - originalMessageDefinition - originalSentOn - instructedAgent - instructingAgent - transactionStatus '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/fedfund-acknowledgement/{messageId}: get: operationId: GetFedFundAcknowledgement tags: - System Messages summary: API to get a fed fund acknowledgement by messageId (admi.007). description: API to ge a fed fund acknowledgement by messageId (admi.007). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: fed fund acknowledgement message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return reference: type: string format: string maxLength: 35 description: This is the reference of the original message. originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 statusCode: type: string format: string enum: - TS01 description: | The code 'TS01' informs of a successful transmission, i.e., the Fedwire Service successfully processed the message and forwarded it to the intended Fedwire Funds participant / Receiver. fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. required: - messageId - instructionId - uetr - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - fedMessage - reference - statusCode - originalMessageDefinition - messageIdentification '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/message-reject/{messageId}: get: operationId: GetMessageReject tags: - System Messages summary: API to get a message reject by messageId (admi.002). description: API to ge a message reject by messageId (admi.002). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: message reject message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. reference: type: string format: string maxLength: 35 description: This is the reference of the original message. reason: type: object properties: rejectingPartyReason: type: string format: string maxLength: 35 description: The reason for the rejection. rejectionDateTime: type: string format: date-time description: | The date and time at which the rejection occurred. This is the timestamp of when the rejection was processed. example: '2025-01-01T12:00:00Z' reasonDescription: type: string format: string maxLength: 350 description: The description of the reason for the rejection. required: - rejectingPartyReason - rejectionDateTime required: - messageId - instructionId - uetr - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - fedMessage - reference - reason '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{messageId}/acknowledge: post: operationId: AcknowledgeMessage tags: - Wires summary: API to acknowledge a message. description: API to acknowledge a message. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/customer/credit-transfer/draft: post: operationId: AddCustomerDraftWire tags: - Draft Wires summary: Api to add a draft wire. description: Method to add a draft wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The wire record to be created. content: application/json: schema: type: object description: The draft customer credit transfer request all root fields are optional, if they are provided which validate as per the ISO 20022 schema. properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. this defaults to creditor agent if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems responses: '201': description: Created content: application/json: schema: type: object properties: draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/customer/credit-transfer/draft/{DraftWireId}: put: operationId: ModifyCustomerDraftWire tags: - Draft Wires summary: Api to modify a draft wire. description: Method to modify a draft wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: DraftWireId in: path description: A unique identifier to find a draft wire. required: true schema: type: string format: uuid requestBody: required: true description: The wire record to be modified. content: application/json: schema: type: object description: The draft customer credit transfer request all root fields are optional, if they are provided which validate as per the ISO 20022 schema. properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. this defaults to creditor agent if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems responses: '200': description: Success content: application/json: schema: type: object properties: draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fi/credit-transfer/draft: post: operationId: AddFIDraftWire tags: - Draft Wires summary: API to add a draft wire. description: Method to add a draft wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: The wire record to be created. content: application/json: schema: type: object description: The draft fi credit transfer request all root fields are optional, if they are provided which validate as per the ISO 20022 schema. properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. this defaults to creditor institution if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: Local Instrument Proprietary Code allowed to accept BTRC, BTRD for Financial Institution wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems responses: '201': description: Created content: application/json: schema: type: object properties: draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fi/credit-transfer/draft/{DraftWireId}: put: operationId: ModifyFIDraftWire tags: - Draft Wires summary: API to modify a draft wire. description: Method to modify a draft wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: DraftWireId in: path description: A unique identifier to find a draft wire. required: true schema: type: string format: uuid requestBody: required: true description: The wire record to be modified. content: application/json: schema: type: object description: The draft fi credit transfer request all root fields are optional, if they are provided which validate as per the ISO 20022 schema. properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. this defaults to creditor institution if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: Local Instrument Proprietary Code allowed to accept BTRC, BTRD for Financial Institution wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems responses: '200': description: Success content: application/json: schema: type: object properties: draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/draft-wire/{DraftWireId}: get: operationId: ViewDraftWireDetails tags: - Draft Wires summary: API to retrieve a draft wire record with wire identifier. description: Method to retrieve draft Wire information by wire identifier parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: DraftWireId in: path description: A unique identifier to find a draft wire. required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory scheduleId: nullable: false type: string format: uuid description: Schedule Id example: 123e4567-e89b-12d3-a456-426614174000 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: DeleteDraftWire tags: - Draft Wires summary: API to delete a draft wire. description: Method to delete a draft wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: DraftWireId in: path description: A unique identifier to find a draft wire. required: true schema: type: string format: uuid responses: '204': description: Success '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/draft-wire/list: get: operationId: DraftWireList tags: - Draft Wires summary: API to retrieve a draft wire List. description: Method to retrieve a draft wire List. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: search in: query description: filter drafts by performing a full-text search across various fields. required: false schema: type: string example: john+doe - name: startDate in: query required: false description: filter drafts by date created on or after the provided value. schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false description: filter drafts by date created on or before the provided value. schema: type: string format: date example: '2025-01-01' - name: startAmount in: query required: false description: filter drafts by amount >= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: endAmount in: query required: false description: filter drafts by amount <= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: excludeConsumerWires in: query required: false description: If true, consumer wires will be excluded from the draft wire list. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object properties: wires: type: array items: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory scheduleId: nullable: false type: string format: uuid description: Schedule Id example: 123e4567-e89b-12d3-a456-426614174000 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/create-wire/{DraftWireId}: post: operationId: CreateWire tags: - Draft Wires summary: API to create a wire from draft. description: Method to create a wire from draft. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: DraftWireId in: path description: A unique identifier to find a draft wire. required: true schema: type: string format: uuid - name: DeleteOnCreate in: query required: false description: If true, the draft will be deleted after the wire is created. schema: type: boolean default: false responses: '201': description: Created content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/override/{messageId}/wire-fee: put: operationId: OverrideWireFee tags: - Account Validation summary: API to override Fee. description: Method to override Fee parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true content: application/json: schema: type: object properties: overrideFee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId overrideOfficer: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 36 description: Override Officer overrideReason: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 100 description: Override Reason required: - overrideFee responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string format: string description: Message example: Override wire fee is successful. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/override/{messageId}/wire-nsf: put: operationId: OverrideNsf tags: - Account Validation summary: API to override NSF. description: Method to override NSF parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true content: application/json: schema: type: object properties: comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 100 description: Comments responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string format: string description: Message example: NSF override is successful. '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/account-validation/{messageId}: get: operationId: ViewWireAccountVerification tags: - Account Validation summary: View Wire Account validation status. description: Method to validate accounts for wire. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Ok content: application/json: schema: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId accountType: type: string format: string enum: - Customer - GeneralLedger description: Account Type example: Customer amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' overrideFee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' isOverrideFee: type: boolean format: boolean description: Override NSF example: true overrideAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId accountOnAnalysis: description: Account On Analysis example: false type: boolean format: boolean isNSF: type: boolean format: boolean description: Override NSF example: true isOverrideNSF: type: boolean format: boolean description: Override NSF example: true overrideOfficer: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 36 description: Override Officer overrideReason: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 100 description: Override Reason comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments accountCheck: type: string format: string enum: - Passed - NotPassed - ByPassed description: Account Check example: Passed balanceCheck: type: string format: string enum: - Passed - NotPassed - ByPassed description: Balance Check example: Passed avlBalanceDuringVal: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdDate: type: string format: date-time description: Created On ISO date format. nullable: false createdBy: type: string description: User who created the wire nullable: false modifiedDate: type: string format: date-time description: Modified On ISO date format. nullable: true modifiedBy: type: string description: User who modified the wire nullable: true required: - account - amount - fee - wireDefinition - transactionType - accountCheck - balanceCheck - createdDate - createdBy '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/accounts: get: operationId: accountsearch tags: - Customer Account Search summary: API to search accounts on core. description: Method to search accounts on core. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: query in: query description: Query to search up entities. example: '?query=john' required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: results: type: array items: type: object properties: accountId: type: string format: string description: Account Id example: D123456789000 accountNumber: type: string format: string description: Account Number example: '123456789' accountType: type: string format: string description: Account Type example: C availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Member Name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - accountId - accountNumber - accountType - name - relationshipCode - postalAddress '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/entities: get: operationId: SearchEntities tags: - Entity Search summary: API to retrieve entities via query parameter description: Method to retrieve entities via query parameter parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: query in: query description: Query to search up entities. example: '?query=john' required: true schema: type: string - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' responses: '200': description: Success content: application/json: schema: type: object properties: entities: type: array items: type: object description: Entity Information properties: entityId: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline required: - entityId - name - postalAddress '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/approval-settings: post: operationId: AddWireApprovalSettings tags: - Legacy Wire Approval Settings summary: API to add settings for wire approval description: Method to add settings for wire approval parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing required: - numberOfEnterpriseApprovers - transactionType minimum: 1 description: Request to add settings for wire approval responses: '201': description: Created '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: UpdateWireApprovalSettings tags: - Legacy Wire Approval Settings summary: API to update settings for wire approval description: Method to add settings for wire approval parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing required: - numberOfEnterpriseApprovers - transactionType minimum: 1 description: Request to add settings for wire approval responses: '200': description: Ok content: application/json: schema: type: array items: type: object properties: numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing institutionUniversalId: type: string description: A unique identifier to establish the identity of an Institution/Environment/Brand combination '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: tags: - Legacy Wire Approval Settings summary: API to get settings for wire approval description: Method to get wire approval settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Approval settings retrieved successfully. content: application/json: schema: type: array items: type: object properties: numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing institutionUniversalId: type: string description: A unique identifier to establish the identity of an Institution/Environment/Brand combination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/wire-approval-settings: post: operationId: AddWireApprovalSettings1 tags: - Wire Approval Settings summary: API to add settings for wire approval description: Method to add settings for wire approval parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing overAmount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' groupId: type: string format: uuid description: A unique identifier to establish the identity of a group required: - numberOfEnterpriseApprovers - transactionType description: Request to add settings for wire approval responses: '201': description: Created '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: tags: - Wire Approval Settings summary: API to get settings for wire approval description: Method to get wire approval settings parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Approval settings retrieved successfully. content: application/json: schema: type: array items: type: object properties: id: type: string format: uuid description: A unique identifier to establish the identity of a setting numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing overAmount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' groupId: type: string format: uuid description: A unique identifier to establish the identity of a group '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/wire-approval-settings/{SettingId}: put: operationId: UpdateWireApprovalAdvancedSettings tags: - Wire Approval Settings summary: API to update settings for wire approval description: Method to update settings for wire approval parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: ApprovalSettingIdParam in: path description: A unique identifier to establish the identity of a setting required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing overAmount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' groupId: type: string format: uuid description: A unique identifier to establish the identity of a group required: - numberOfEnterpriseApprovers - transactionType description: Request to add settings for wire approval responses: '200': description: Ok content: application/json: schema: type: object properties: id: type: string format: uuid description: A unique identifier to establish the identity of a setting numberOfEnterpriseApprovers: type: integer format: int32 minimum: 1 maximum: 10 description: Number of enterprise approvers required for approval transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing overAmount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: DeleteWireApprovalAdvancedSettings tags: - Wire Approval Settings summary: API to delete settings for wire approval description: Method to delete settings for wire approval parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: ApprovalSettingIdParam in: path description: A unique identifier to establish the identity of a setting required: true schema: type: string format: uuid responses: '204': description: deleted '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/users/enterprise/{EnterpriseUserIdParam}/approvals: post: tags: - Enterprise Approvals summary: Create an enterprise approval request parameters: - in: path name: EnterpriseUserIdParam required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object required: - consumerUserApprovalRequested - consumerUserApprovalRequired - numberOfConsumerApprovalsRequired - enterpriseUserApprovalRequired - enterpriseUserApprovalRequested - numberOfEnterpriseApprovalsRequired properties: numberOfConsumerApprovalsRequired: type: integer description: Number of consumer users involved. consumerUserApprovalRequested: type: array items: type: string format: uuid description: Consumer who have been requested to approve the item. consumerUserApprovalRequired: type: array items: type: string format: uuid description: Consumer who have approved the item. enterpriseUserApprovalRequired: type: array items: type: string format: uuid description: Enterprise Users who have approved the item. enterpriseUserApprovalRequested: type: array items: type: string format: uuid description: Enterprise User who has been requested to approve the item. permissions: type: object required: - sorId - permissionSets properties: sorId: type: string description: The optional System of Record (SOR) or product ID that needs approval. permissionSets: type: object description: The optional permission sets requiring approval. Key-value pairs where keys are permission names and values are booleans indicating whether the permission is granted. example: ApproveWires: true ViewBalances: false numberOfEnterpriseApprovalsRequired: type: integer description: Number of enterprise users involved. validationData: type: object description: A user defined object that will be validated against the approval request. Example, the wire amount must be validated on the approval. example: amount: 100 responses: '201': description: Approval request created successfully. content: application/json: schema: type: object properties: id: type: string format: uuid description: ID of the created approval item. /a/api/jh-wires/v2/{InstitutionUniversalId}/users/enterprise/{EnterpriseUserIdParam}/approvals/{id}: get: tags: - Enterprise Approvals summary: Get an enterprise approval by ID parameters: - in: path name: id required: true schema: type: string format: uuid description: The ID of the approval. - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserIdParam required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Approval retrieved successfully. content: application/json: schema: type: object required: - id - status - consumerUserApprovalRequired - enterpriseUserApprovalRequired - enterpriseApprovalTotalCount - consumerApprovalTotalCount properties: id: type: string format: uuid description: ID of the created approval request. status: type: string enum: - PENDING - REJECTED - APPROVED description: Status of the approval request. consumerUserApprovalRequested: type: array items: type: string format: uuid description: Consumers who have been requested to approve the item. consumerUserApprovalRequired: type: array items: type: string format: uuid description: Consumers who have approved the item. enterpriseUserApprovalRequired: type: array items: type: string format: uuid description: Enterprise Users who have approved the item. enterpriseUserApprovalRequested: type: array items: type: string format: uuid description: Enterprise User who has been requested to approve the item. consumerApprovals: type: array items: type: object required: - userId - approvalStatus - submittedAt properties: userId: type: string format: uuid description: The ID of the user. approvalStatus: type: string enum: - REJECTED - APPROVED description: The status of the approval. comment: type: string description: A comment from the user. example: I approve this request. submittedAt: type: string format: date-time description: The date and time the approval was submitted. enterpriseApprovals: type: array items: type: object required: - userId - approvalStatus - submittedAt properties: userId: type: string format: uuid description: The ID of the user. approvalStatus: type: string enum: - REJECTED - APPROVED description: The status of the approval. comment: type: string description: A comment from the user. example: I approve this request. submittedAt: type: string format: date-time description: The date and time the approval was submitted. enterpriseApprovalsRequired: type: integer description: Number of enterprise users involved. enterpriseApprovalTotalCount: type: integer description: Number of enterprise users involved. consumerApprovalsRequired: type: integer description: Number of consumer users involved. consumerApprovalTotalCount: type: integer description: Number of consumer users involved. comment: type: string description: Comments related to the approval request. bypassed: type: boolean description: Indicates if the approval was bypassed. extraData: type: object properties: groupId: type: string format: uuid description: ID of the associated group, if any. wireId: type: string format: uuid description: ID of the associated wire. description: Extra data about the approval. put: tags: - Enterprise Approvals summary: Update/Approve an enterprise approval request description: Use this endpoint to update an existing enterprise approval request, including approving it. parameters: - in: path name: id required: true schema: type: string format: uuid description: The ID of the approval. - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserIdParam required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: required: true content: application/json: schema: type: object properties: status: type: string enum: - REJECTED - APPROVED comment: type: string description: A comment from the user. example: I approve this request. validationData: type: object description: A user defined object that will be validated against the approval request. Example, the wire amount must be validated on the approval. example: amount: 100 responses: '200': description: Approval request updated successfully. content: application/json: schema: type: object properties: id: type: string format: uuid description: ID of the created approval item. /a/api/jh-wires/v2/{InstitutionUniversalId}/notifications/accounts/list: post: tags: - Wire Notifications summary: List Wire Notification Accounts description: List all accounts configured for wire notifications operationId: listWireNotificationAccounts parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: content: application/json: schema: type: object required: - institutionId properties: institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. responses: '200': description: Ok content: application/json: schema: type: object properties: accounts: type: array items: type: object properties: id: type: string format: uuid description: ID of the wire notification account institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 customerName: type: string description: The name of the customer accountDescription: type: string description: Description of the account '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/notifications/accounts: post: tags: - Wire Notifications summary: Create Wire Notification Account description: Creates a wire notification account operationId: createWireNotificationAccount parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: content: application/json: schema: type: object required: - institutionId - accountId - customerName - accountDescription properties: institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 customerName: type: string description: The name of the customer accountDescription: type: string description: Description of the account responses: '201': description: Created content: application/json: schema: type: object properties: wireNotificationAccount: type: object properties: id: type: string format: uuid description: ID of the wire notification account institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 customerName: type: string description: The name of the customer accountDescription: type: string description: Description of the account '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/notifications/accounts/{Id}: get: tags: - Wire Notifications summary: Get Wire Notification Account description: View a specific wire notification account record operationId: getAccount parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: Id required: true schema: type: string format: uuid description: A unique identifier for the resource. responses: '200': description: Ok content: application/json: schema: type: object properties: wireNotificationAccount: type: object properties: id: type: string format: uuid description: ID of the wire notification account institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 customerName: type: string description: The name of the customer accountDescription: type: string description: Description of the account '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: tags: - Wire Notifications summary: Update Wire Notification Account description: Updates a wire notification account operationId: updateAccount parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: Id required: true schema: type: string format: uuid description: A unique identifier for the resource. requestBody: content: application/json: schema: type: object properties: wireNotificationAccount: type: object properties: id: type: string format: uuid description: ID of the wire notification account institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 customerName: type: string description: The name of the customer accountDescription: type: string description: Description of the account responses: '200': description: Ok content: application/json: schema: type: object properties: wireNotificationAccount: type: object properties: id: type: string format: uuid description: ID of the wire notification account institutionId: type: string format: uuid description: | A unique identifier for the institution. This is a UUID that is used to identify the institution in the system. It is used to associate the wire notification account with the institution. accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 customerName: type: string description: The name of the customer accountDescription: type: string description: Description of the account '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: tags: - Wire Notifications summary: Remove Wire Notification Account description: Removes a wire notification account operationId: removeAccount parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: Id required: true schema: type: string format: uuid description: A unique identifier for the resource. responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/notifications/contacts/list: post: tags: - Wire Notifications summary: List Account Contacts description: List all the wire notification contacts for the account operationId: listAccountContacts parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: content: application/json: schema: type: object required: - accountId properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 responses: '200': description: Ok content: application/json: schema: type: object properties: contacts: type: array items: type: object properties: id: type: string format: uuid description: ID of the contact record contactMethod: type: string enum: - email description: The method of contact contactInfo: type: string description: The information needed to send a message to this contact eventTypes: type: array items: type: string enum: - incoming - outgoing '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/notifications/contacts: post: tags: - Wire Notifications summary: Create Account Contact description: Creates a wire notification contact for an account operationId: createAccountContact parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: content: application/json: schema: type: object required: - accountId - contactMethod - contactInfo - eventTypes properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 contactMethod: type: string enum: - email description: The method of contact contactInfo: type: string description: The information needed to send a message to this contact eventTypes: type: array items: type: string enum: - incoming - outgoing responses: '201': description: Created content: application/json: schema: type: object properties: id: type: string format: uuid description: ID of the contact record contactMethod: type: string enum: - email description: The method of contact contactInfo: type: string description: The information needed to send a message to this contact eventTypes: type: array items: type: string enum: - incoming - outgoing '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/notifications/contacts/{Id}: get: tags: - Wire Notifications summary: Get Account Contact description: View a specific account wire notification contact record operationId: getAccountContact parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: Id required: true schema: type: string format: uuid description: A unique identifier for the resource. responses: '200': description: Ok content: application/json: schema: type: object properties: id: type: string format: uuid description: ID of the contact record contactMethod: type: string enum: - email description: The method of contact contactInfo: type: string description: The information needed to send a message to this contact eventTypes: type: array items: type: string enum: - incoming - outgoing '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: tags: - Wire Notifications summary: Update Account Contact description: Updates an account's wire notification contact operationId: updateAccountContact parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: Id required: true schema: type: string format: uuid description: A unique identifier for the resource. requestBody: content: application/json: schema: type: object required: - contactMethod - contactInfo - eventTypes properties: contactMethod: type: string enum: - email description: The method of contact contactInfo: type: string description: The information needed to send a message to this contact eventTypes: type: array items: type: string enum: - incoming - outgoing responses: '200': description: Ok content: application/json: schema: type: object properties: id: type: string format: uuid description: ID of the contact record contactMethod: type: string enum: - email description: The method of contact contactInfo: type: string description: The information needed to send a message to this contact eventTypes: type: array items: type: string enum: - incoming - outgoing '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: tags: - Wire Notifications summary: Remove Account Contact description: Removes an account's wire notification contact operationId: removeAccountContact parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: Id required: true schema: type: string format: uuid description: A unique identifier for the resource. responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/money-movement-status/{messageId}: get: operationId: ViewWireMoneyMovementStatus tags: - Wire Money Movement Status summary: API to view a wire money movement status. description: Method to view a wire money movement status. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Ok content: application/json: schema: type: object properties: paymentUetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 messageIdentifier: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). sentOn: type: string format: date-time description: Sent On ISO date format. comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments steps: type: array items: type: object properties: step: type: string format: string enum: - ProcessAmount - ProcessFee - AccountAnalysis - FedSend description: Step example: ProcessAmount status: type: string format: string enum: - InProcess - Passed - NotPassed - ByPassed description: StepStatus example: Passed description: List of steps in the wire transaction '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/config: get: operationId: ViewFedlineDirectConfig tags: - Fedline Direct summary: API to view a fedline direct config. description: Method to view a fedline direct config. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: institutionId: type: string format: uuid description: Institution ID example: a3badfa6-00eb-4b0f-9881-d9c6ba95ca8b lTerm: type: string format: string description: LTerm example: ABCDE789 fedlineDirect: type: boolean format: boolean description: Is Fedline Direct example: false executeFedBalance: type: boolean format: boolean description: Execute Fed Balance example: false masterRtId: type: string format: string description: Master Routing Id example: '123456789' subRtId: type: string format: string description: Sub Routing Id example: '987654321' consumerName: type: string format: string description: Consumer Name example: Consumer Name consumerProduct: type: string format: string description: Consumer Product example: Consumer Product required: - institutionId - fedlineMode - fedlineDirect - executeFedBalance '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: UpdateFedlineDirectConfig tags: - Fedline Direct summary: API to update a fedline direct config. description: Method to update a fedline direct config. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: fedlineDirect: type: boolean description: Is Fedline Direct example: false executeFedBalance: type: boolean description: Execute Fed Balance example: false required: - fedlineDirect - executeFedBalance responses: '200': description: Ok content: application/json: schema: type: object properties: message: type: string description: Fedline Config updated successfully. example: Fedline Config updated successfully. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fee-setting: post: operationId: AddInstitutionFeeSetting tags: - Institution Fee Settings summary: API to add a Fee record. description: Method to add a Fee record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false required: - feeCategory - fee - transactionType responses: '201': description: Created content: application/json: schema: type: object properties: feeId: type: string format: uuid description: Fee Id. example: 123e4567-e89b-12d3-a456-426614174000 feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetAllInstitutionFeeSettings tags: - Institution Fee Settings summary: API to get over all fee settings by Institution. description: Method to get over all fee settings by Institution. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: success content: application/json: schema: type: array items: type: object properties: feeId: type: string format: uuid description: Fee Id. example: 123e4567-e89b-12d3-a456-426614174000 feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fee-setting/{FeeId}: put: operationId: ModifyInstitutionFeeSetting tags: - Institution Fee Settings summary: API to modify a Fee record. description: Method to modify a Fee record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: FeeId in: path description: A unique identifier to find a fee. required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false required: - feeCategory - fee - transactionType responses: '200': description: success content: application/json: schema: type: object properties: feeId: type: string format: uuid description: Fee Id. example: 123e4567-e89b-12d3-a456-426614174000 feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetInstitutionFeeSetting tags: - Institution Fee Settings summary: API to get a Fee record. description: Method to get a Fee record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: FeeId in: path description: A unique identifier to find a fee. required: true schema: type: string format: uuid responses: '200': description: success content: application/json: schema: type: object properties: feeId: type: string format: uuid description: Fee Id. example: 123e4567-e89b-12d3-a456-426614174000 feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: DeleteInstitutionFeeSetting tags: - Institution Fee Settings summary: API to delete a Fee record. description: Method to delete a Fee record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: FeeId in: path description: A unique identifier to find a fee. required: true schema: type: string format: uuid responses: '204': description: success '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/config/SymxConfig: post: operationId: AddSymxCoreConfig tags: - Symitar FI Configuration Settings summary: API to add a symx config record. description: Method to add a symx config record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: deviceNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Number example: '20900' deviceType: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Type example: BANNO shareIdLength: type: integer format: int32 oneOf: - minimum: 2 maximum: 2 - minimum: 4 maximum: 4 description: Share Id length either 2 or 4 example: 2 version: type: string format: string description: Version example: '2020.01' required: - deviceNumber - deviceType - shareIdLength - version responses: '201': description: Created content: application/json: schema: type: object properties: message: type: string format: string description: Message example: Config record added successfully '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetSymxCoreConfig tags: - Symitar FI Configuration Settings summary: API to get a symx config record. description: Method to get a symx config record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: deviceNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Number example: '20900' deviceType: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Type example: BANNO shareIdLength: type: integer format: int32 oneOf: - minimum: 2 maximum: 2 - minimum: 4 maximum: 4 description: Share Id length either 2 or 4 example: 2 version: type: string format: string description: Version example: '2020.01' required: - deviceNumber - deviceType - shareIdLength - version '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/setting/symtrn-setting: post: operationId: AddSymTransactionSetting tags: - Symitar FI Transaction Settings summary: API to add a symx transaction settings. description: Method to add a symx transaction settings.. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: serviceFeeCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Service Fee Code example: service fee code is 8 for the symitar core example: '8' transactionSourceCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Transaction source code example: transaction source code is M for the symitar core example: M outgoingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Outgoing Shared Analysis Code example: outgoing shared analysis code is 18 for the symitar core example: '18' incomingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Incoming Shared Analysis Code example: incoming shared analysis code is 17 for the symitar core example: '17' draft: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Share: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber generalLedger: type: object properties: Outgoing: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber required: - serviceFeeCode - transactionSourceCode - outgoingSharedAnalysisCode - incomingSharedAnalysisCode responses: '201': description: Created content: application/json: schema: type: object properties: message: type: string format: string description: Message example: Transaction Setting record added successfully '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetSymTransactionSetting tags: - Symitar FI Transaction Settings summary: API to get a symx transaction settings. description: Method to get a symx transaction settings. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: serviceFeeCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Service Fee Code example: service fee code is 8 for the symitar core example: '8' transactionSourceCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Transaction source code example: transaction source code is M for the symitar core example: M outgoingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Outgoing Shared Analysis Code example: outgoing shared analysis code is 18 for the symitar core example: '18' incomingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Incoming Shared Analysis Code example: incoming shared analysis code is 17 for the symitar core example: '17' draft: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Share: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber generalLedger: type: object properties: Outgoing: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/common-settings: post: operationId: AddCommonSettings tags: - Silverlake FI Settings summary: API to add a Silverlake common settings record. description: Method to add a Silverlake common settings record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: avlBalanceCalCode: type: string description: The code used to calculate the available balance. example: AVL_BALANCE maxLength: 50 minLength: 1 pattern: ^[A-Z0-9_]+$ useGLCostCenter: type: boolean description: Indicates whether the GL cost center is used. example: true useGLProductCode: type: boolean description: Indicates whether the GL product code is used. example: true valBalanceChecking: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceSavings: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceLoan: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceOverdraft: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceClub: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available allowedAcctTypes: type: array description: The allowed account types. items: type: string description: The allowed account type. enum: - Checking - Savings - Loan - Overdraft example: SAVINGS allowedRelations: type: array description: The allowed relationships. items: type: string description: The allowed relationship. enum: - P - J example: P createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true required: - avlBalanceCalCode - useGLCostCenter - useGLProductCode - valBalanceChecking - valBalanceSavings - valBalanceLoan - valBalanceOverdraft - valBalanceClub responses: '201': description: Created content: application/json: schema: type: object properties: avlBalanceCalCode: type: string description: The code used to calculate the available balance. example: AVL_BALANCE maxLength: 50 minLength: 1 pattern: ^[A-Z0-9_]+$ useGLCostCenter: type: boolean description: Indicates whether the GL cost center is used. example: true useGLProductCode: type: boolean description: Indicates whether the GL product code is used. example: true valBalanceChecking: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceSavings: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceLoan: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceOverdraft: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceClub: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available allowedAcctTypes: type: array description: The allowed account types. items: type: string description: The allowed account type. enum: - Checking - Savings - Loan - Overdraft example: SAVINGS allowedRelations: type: array description: The allowed relationships. items: type: string description: The allowed relationship. enum: - P - J example: P createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true required: - avlBalanceCalCode - useGLCostCenter - useGLProductCode - valBalanceChecking - valBalanceSavings - valBalanceLoan - valBalanceOverdraft - valBalanceClub '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetCommonSettings tags: - Silverlake FI Settings summary: API to get a Silverlake common settings record. description: Method to get a Silverlake common settings record. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: avlBalanceCalCode: type: string description: The code used to calculate the available balance. example: AVL_BALANCE maxLength: 50 minLength: 1 pattern: ^[A-Z0-9_]+$ useGLCostCenter: type: boolean description: Indicates whether the GL cost center is used. example: true useGLProductCode: type: boolean description: Indicates whether the GL product code is used. example: true valBalanceChecking: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceSavings: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceLoan: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceOverdraft: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceClub: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available allowedAcctTypes: type: array description: The allowed account types. items: type: string description: The allowed account type. enum: - Checking - Savings - Loan - Overdraft example: SAVINGS allowedRelations: type: array description: The allowed relationships. items: type: string description: The allowed relationship. enum: - P - J example: P createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true required: - avlBalanceCalCode - useGLCostCenter - useGLProductCode - valBalanceChecking - valBalanceSavings - valBalanceLoan - valBalanceOverdraft - valBalanceClub '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/transaction-settings: post: operationId: AddTransactionSetting tags: - Silverlake FI Settings summary: API to add a Silverlake transaction settings. description: Method to add a Silverlake transaction settings.. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: accountType: type: string description: The account type. enum: - Deposit - Savings - Loan - GeneralLedger example: Deposit transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing sourceCode: type: string description: The transaction source code. example: '@1' maxLength: 10 pattern: ^[A-Z0-9@]+$ sourceCodeDescription: type: string description: The transaction source code description. example: Source Code Description maxLength: 50 pattern: ^[A-Za-z0-9]+$ transactionCode: type: string description: The transaction code. example: '111' maxLength: 10 pattern: ^[A-Za-z0-9]+$ glInterfaceCode: type: string description: The GL interface code. example: GL Interface Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementAccountNumber: type: string description: The GL settlement account number. example: GL Settlement Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementBranchNumber: type: string description: The GL settlement branch number. example: GL Settlement Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCostCenter: type: string description: The GL settlement cost center. example: GL Settlement Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementProductCode: type: string description: The GL settlement product code. example: GL Settlement Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCode: type: string description: The GL settlement code. example: GL Settlement Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderAccountNumber: type: string description: The GL provider account number. example: GL Provider Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderBranchNumber: type: string description: The GL provider branch number. example: GL Provider Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCostCenter: type: string description: The GL provider cost center. example: GL Provider Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderProductCode: type: string description: The GL provider product code. example: GL Provider Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCode: type: string description: The GL provider code. example: GL Provider Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - accountType - transactionType - sourceCode - sourceCodeDescription - transactionCode - glInterfaceCode responses: '200': description: success '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetTransactionSetting tags: - Silverlake FI Settings summary: API to get a Silverlake transaction settings. description: Method to get a Silverlake transaction settings. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: array items: type: object properties: accountType: type: string description: The account type. enum: - Deposit - Savings - Loan - GeneralLedger example: Deposit transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing sourceCode: type: string description: The transaction source code. example: '@1' maxLength: 10 pattern: ^[A-Z0-9@]+$ sourceCodeDescription: type: string description: The transaction source code description. example: Source Code Description maxLength: 50 pattern: ^[A-Za-z0-9]+$ transactionCode: type: string description: The transaction code. example: '111' maxLength: 10 pattern: ^[A-Za-z0-9]+$ glInterfaceCode: type: string description: The GL interface code. example: GL Interface Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementAccountNumber: type: string description: The GL settlement account number. example: GL Settlement Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementBranchNumber: type: string description: The GL settlement branch number. example: GL Settlement Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCostCenter: type: string description: The GL settlement cost center. example: GL Settlement Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementProductCode: type: string description: The GL settlement product code. example: GL Settlement Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCode: type: string description: The GL settlement code. example: GL Settlement Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderAccountNumber: type: string description: The GL provider account number. example: GL Provider Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderBranchNumber: type: string description: The GL provider branch number. example: GL Provider Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCostCenter: type: string description: The GL provider cost center. example: GL Provider Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderProductCode: type: string description: The GL provider product code. example: GL Provider Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCode: type: string description: The GL provider code. example: GL Provider Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - accountType - transactionType - sourceCode - sourceCodeDescription - transactionCode - glInterfaceCode '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{institutionId}/transaction-settings/accountType/{accountType}/transactionType/{transactionType}/sourceCode/{sourceCode}: delete: operationId: DeleteTransactionSetting tags: - Silverlake FI Settings summary: API to delete a Silverlake transaction settings. description: Method to delete a Silverlake transaction settings. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: AccountType in: path description: The account type. required: true schema: type: string enum: - Deposit - Savings - Loan - GeneralLedger example: Deposit - name: TransactionType in: path description: The transaction type. required: true schema: type: string enum: - Incoming - Outgoing example: Outgoing - name: SourceCode in: path description: The transaction source code. required: true schema: type: string maxLength: 10 pattern: ^[A-Z0-9@]+$ example: '@1' responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{institutionId}/feecode-settings: post: operationId: AddFeeCodeSetting tags: - Silverlake FI Settings summary: API to add a Silverlake fee code settings. description: Method to add a Silverlake fee code settings.. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing feeCategory: type: string format: string description: The fee category. enum: - Regular - Return - Schedule example: Regular feeCode: type: string format: string description: The fee code. example: CN maxLength: 10 pattern: ^[A-Za-z0-9]+$ analysisCode: type: string format: string description: The analysis code. example: '100' maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - feeCode - feeCategory - feeAmount responses: '200': description: success '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetFeeCodeSettings tags: - Silverlake FI Settings summary: API to get a Silverlake fee code settings. description: Method to get a Silverlake fee code settings. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: feeCodes: type: array items: description: The fee code settings. example: - transactionType: Outgoing feeCategory: Regular feeCode: CN analysisCode: '100' - transactionType: Incoming feeCategory: Return feeCode: CP analysisCode: '200' type: object properties: transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing feeCategory: type: string format: string description: The fee category. enum: - Regular - Return - Schedule example: Regular feeCode: type: string format: string description: The fee code. example: CN maxLength: 10 pattern: ^[A-Za-z0-9]+$ analysisCode: type: string format: string description: The analysis code. example: '100' maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - feeCode - feeCategory - feeAmount '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{institutionId}/feecode-settings/transactionType/{transactionType}/feeCategory/{feeCategory}: delete: operationId: DeleteFeeCodeSetting tags: - Silverlake FI Settings summary: API to delete a Silverlake fee code settings. description: Method to delete a Silverlake fee code settings. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: TransactionType in: path description: The transaction type. required: true schema: type: string enum: - Incoming - Outgoing example: Outgoing - name: FeeCategory in: path description: The fee category. required: true schema: type: string enum: - Regular - Return - Schedule example: Regular responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/incoming-messages/{FileId}: get: operationId: ListIncomingMessageByFileId tags: - Incoming wire file summary: API to retrieve Incoming Messages By FileId description: Method to list incoming messages by FileId. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: FileId in: path description: A unique identifier to identity a file. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Ok content: application/json: schema: type: object properties: messages: type: array items: type: object properties: fileId: type: string format: uuid description: A unique identifier to identity a file. example: 123e4567-e89b-12d3-a456-426614174000 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. status: type: string format: string enum: - Processing - Complete - Rejected comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/incoming-messages: get: operationId: ListIncomingFedlineDirectMessages tags: - Fedline Direct summary: API to retrieve Incoming Fedline Direct Messages description: Method to list incoming Fedline Direct messages. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: uetr in: query description: Universally unique identifier to provide an end-to-end reference of a payment transaction (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: businessDefinition in: query description: | Business Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.001.001.12 - consumer transfer request 5. pain.013.001.07 - drawdown request 6. pain.014.001.07 - drawdown response 7. camt.056.001.08 - return request 8. camt.029.001.09 - return response 9. camt.110.001.01 - investigation request 10. cam.111.001.01 - investigation response 11. pacs.028.001.03 - payment status request 12. pacs.002.001.10 - payment status 13. admi.002.001.01 - message rejection 14. admi.007.001.01 - message acknowledgement 15. admi.004.001.02 - ping or broadcast 16. admi.006.001.01 - retrieval request 17. admi.011.001.01 - system response 18. camt.052.001.08 - account reporting 19. camt.060.001.05 - reporting request schema: type: array maxItems: 6 items: type: string format: string enum: - customer transfer - fi transfer - payment return - customer transfer request - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - reporting request - name: startDate in: query required: false description: filter messages by date created on or after the provided value. schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false description: filter messages by date created on or before the provided value. schema: type: string format: date example: '2025-01-01' - name: fedMessageSearch in: query required: false description: filter messages by performing a full-text search on the incoming fed message. schema: type: string example: john+doe - name: status in: query description: query to filter messages by Status required: false schema: type: string format: string enum: - Success - Failed - Processing - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: isDuplicate in: query description: query to filter messages by the isDuplicate boolean required: false schema: type: boolean responses: '200': description: Ok content: application/json: schema: type: object properties: messages: type: array items: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. status: type: string format: string description: The status of the incoming message. enum: - Success - Processing - Failed comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false isDuplicate: type: boolean description: Indicates whether the message is a duplicate required: - fedMessage - createdOn - status paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/system-messages: get: operationId: ListFedlineDirectSystemMessages tags: - Fedline Direct summary: API to retrieve Fedline Direct System Messages description: Method to list Fedline Direct System messages. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: startDate in: query required: false description: filter messages by date created on or after the provided value. schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false description: filter messages by date created on or before the provided value. schema: type: string format: date example: '2025-01-01' - name: wireDefinition in: query description: query to filter messages by wire-definition required: false schema: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 example: pacs.008.001.08 - name: fedMessageSearch in: query required: false description: filter messages by performing a full-text search on the incoming fed message. schema: type: string example: john+doe - name: type in: query description: query to filter messages by admi type required: false schema: type: string format: string enum: - Info - Warn - Error - name: isRead in: query description: query to filter messages by the isRead boolean required: false schema: type: string format: boolean - name: isMapped in: query description: query to filter messages by the isMapped boolean required: false schema: type: string format: boolean - name: messageId in: query description: query to filter messages by messageId list required: false schema: type: array items: type: string - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' responses: '200': description: Ok content: application/json: schema: type: object properties: messages: type: array items: type: object properties: id: type: string format: uuid description: ID refers to the unique identifier for the specific admi message messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. type: type: string description: the type of admi message enum: - Info - Warn - Error isRead: type: string format: boolean description: Expresses whether the message has been processed or not example: true isMapped: type: string format: boolean description: Expresses whether the message is mapped to another message example: true mappedMessageId: type: string format: uuid description: Refers to the unique identifier for message the system message is linked to createdOn: type: string format: date-time description: Created On ISO date format. nullable: false createdBy: type: string description: User who created the wire nullable: false statusDetails: type: string format: string description: Additional info provided in the system message regarding its status. required: - id - fedMessage - type - createdBy - createdOn paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/customer-credit-transfer/{messageId}: get: operationId: GetCustomerCreditTransfer tags: - Customer Credit Transfers summary: API to get a customer credit transfer by messageId (pacs.008). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: customer credit transfer message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uETR paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: Local Instrument Proprietary Code. Possible values are CTRC and CTRD. If CTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. authType: type: string nullable: true glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditorAgent - debtorAgent - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - paymentIdentification - paymentTypeInformation - fedMessage description: | The message is used to provide information about response of pacs.008 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/fi-credit-transfer/{messageId}: get: operationId: GetFICreditTransfer tags: - FI Credit Transfers summary: API to get a fi credit transfer by messageId (pacs.009). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: fi credit transfer message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uETR paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: Local Instrument Proprietary Code. Possible values are BTRC and BTRD. If BTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. authType: type: string nullable: true glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - paymentIdentification - paymentTypeInformation - fedMessage description: | The message is used to provide information about response of pacs.009 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/messages/{uetr}/payment-return/{messageId}: get: operationId: GetPaymentReturn tags: - Returns summary: API to get a payment return by messageId (pacs.004). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid responses: '200': description: payment return message found content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' returnedInterbankSettlementAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' returnInstructedAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true originalPaymentIdentification: type: object properties: originalInstructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. originalEndToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. originalUETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - originalEndToEndIdentification - originalUETR originalPaymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code. Possible values are CTRC, CTRD, BTRC and BTRD. If CTRD, BTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' returnReasonInformation: description: Return Reason Information. This is used to provide the reason for the return of a payment. type: object properties: returnReason: type: object properties: reasonCode: type: string format: string enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: | Return reason codes should contain a code from the ISO 20022 externalized ReturnReason1Code code list. example: AC01 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the drawdown response. required: - reasonCode required: - returnReason fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - messageId - instructionId - uetr - approvalId - amount - returnedInterbankSettlementAmount - returnInstructedAmount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - originalPaymentIdentification - originalPaymentTypeInformation - originalMessageIdentification - originalMessageDefinition - originalSentOn - returnReasonInformation - fedMessage description: | The message is used to provide information about response of pacs.004. uetr and original uetr both are same. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: CreatePaymentReturn tags: - Returns summary: API to create a payment return (pacs.004). description: API to create a payment return (pacs.004). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: UETR in: path description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: true schema: type: string format: uuid - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 requestBody: required: true content: application/json: schema: type: object properties: returnReason: type: object properties: reasonCode: type: string format: string minLength: 1 maxLength: 4 enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: Return reason code should contain four alphanumeric character code from the ISO 20022 externalized ReturnReason1Code list additionalInfo: type: array items: type: string format: string minLength: 1 maxLength: 105 maxItems: 2 description: Further details on the return reason. required: - reasonCode glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - returnReason description: | Request to create a payment return (pacs.004) message. responses: '200': description: payment return created content: application/json: schema: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - wireId - uetr description: | Response after creating a payment return (pacs.004) message. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/create-disclaimer: post: operationId: CreateDisclaimer tags: - Wire Settings summary: API to add disclaimers to an FI. description: Method to add disclaimers to an FI. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object minProperties: 1 properties: disclaimerText: type: string description: The desired disclaimer text to be associated with the institution signatureText: type: string description: The desired signature text to be associated with the insitution responses: '201': description: Ok content: application/json: schema: type: array items: example: settingId: dacd9529-75fe-4663-84f1-285ad3d19451 type: object properties: settingId: type: string format: uuid description: Identifier for disclaimer that was created '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/get-disclaimer: get: operationId: GetDisclaimer tags: - Wire Settings summary: API to get a disclaimer. description: Method to get a disclaimer on an FI. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: settingName: type: string description: Name of setting settingId: type: string format: uuid description: Identifier for disclaimer settingValue: type: string description: Value of the disclaimer createdOn: type: string format: date-time modifiedOn: type: string format: date-time example: settingId: dacd9529-75fe-4663-84f1-285ad3d19451 institutionId: a3badfa6-00eb-4b0f-9881-d9c6ba95ca8b settingName: disclaimers.disclaimer settingValue: example disclaimer text createdOn: '0001-01-01T00:00:00Z' modifiedOn: '0001-01-01T00:00:00Z' '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/update-disclaimer/{DisclaimerId}: put: operationId: UpdateDisclaimer tags: - Wire Settings summary: API to update disclaimers. description: Method to update disclaimers for an FI. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: DisclaimerId in: path description: A unique identifier to establish the identity of a disclaimer required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: disclaimerText: type: string description: The desired disclaimer text to be associated with the institution responses: '200': description: Ok content: application/json: schema: type: object properties: settingId: type: string format: uuid description: Identifier for disclaimer that was updated settingValue: type: string description: New disclaimer value example: settingId: a3badfa6-00eb-4b0f-9881-d9c6ba95ca8b settingValue: updated disclaimer text '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/incoming-message: post: operationId: AddIncomingFedMessage tags: - Fedline Direct summary: API to receive an incoming message from the Fed. description: Method to receive an incoming message from the Fed. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: message: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. responses: '201': description: created content: application/json: schema: type: object properties: messageReference: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/outgoing-messages: get: operationId: ListOutgoingFedlineDirectMessages tags: - Fedline Direct summary: API to retrieve Outgoing Fedline Direct Messages description: Method to list Outgoing Fedline Direct messages. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: uetr in: query description: Universally unique identifier to provide an end-to-end reference of a payment transaction (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: businessDefinition in: query description: | Business Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.001.001.12 - consumer transfer request 5. pain.013.001.07 - drawdown request 6. pain.014.001.07 - drawdown response 7. camt.056.001.08 - return request 8. camt.029.001.09 - return response 9. camt.110.001.01 - investigation request 10. cam.111.001.01 - investigation response 11. pacs.028.001.03 - payment status request 12. pacs.002.001.10 - payment status 13. admi.002.001.01 - message rejection 14. admi.007.001.01 - message acknowledgement 15. admi.004.001.02 - ping or broadcast 16. admi.006.001.01 - retrieval request 17. admi.011.001.01 - system response 18. camt.052.001.08 - account reporting 19. camt.060.001.05 - reporting request schema: type: array maxItems: 6 items: type: string format: string enum: - customer transfer - fi transfer - payment return - customer transfer request - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - reporting request - name: messageId in: query description: A unique identifier to identify a message (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: startDate in: query required: false description: filter messages by date created on or after the provided value. schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false description: filter messages by date created on or before the provided value. schema: type: string format: date example: '2025-01-01' - name: fedMessageSearch in: query required: false description: filter messages by performing a full-text search on the incoming fed message. schema: type: string example: john+doe - name: startAmount in: query required: false description: filter wires by amount >= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: endAmount in: query required: false description: filter wires by amount <= the provided value. schema: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: status in: query description: query to filter messages by Status required: false schema: type: string format: string enum: - Processing - Complete - Failed - Rejected - name: fedCalendarCheck in: query description: query to filter messages by fed calendar check required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Bypassed - name: fedConnectionCheck in: query description: query to filter messages by fed connection check required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Bypassed - name: fedBalanceCheck in: query description: query to filter messages by fed balance check required: false schema: type: string format: string enum: - InProcess - Passed - NotPassed - Bypassed - name: overFedAdvantage in: query description: query to filter messages by over fed advantage required: false schema: type: boolean format: boolean - name: processingTimeOut in: query description: query to filter messages by processing time out required: false schema: type: string format: boolean - name: autoGeneratedFromValueMessage in: query description: Flag to indicates if the message was auto-generated as part of the validation process of a value message. required: false schema: type: string format: boolean responses: '200': description: Ok content: application/json: schema: type: object properties: messages: type: array items: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). status: type: string format: string enum: - Processing - Complete - Failed - Rejected statusReason: type: string format: string description: Reason for the current status of the outgoing message. expectedExecutionDateTime: type: string format: date-time description: The date and time when the wire is expected to be processed. fedCalendarCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Calendar Check. fedCalendarCheckComments: type: string format: string description: Comments regarding the Federal Calendar Check. fedCalendarDateTime: type: string format: date-time description: The date and time when the Fed calendar check was performed. fedConnectionCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: status on fed connection check. fedConnectionCheckComments: type: string format: string description: Comments regarding the fed connection check. fedConnectionExpectedDateTime: type: string format: date-time description: The date and time when the fed connect check expected. fedBalanceCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Balance Check. fedBalanceCheckComments: type: string format: string description: Comments regarding the Federal Balance Check. fedBalanceExcutionDateTime: type: string format: date-time description: The date and time when the Federal Balance Check was executed. fedBalance: type: string format: number minimum: 0.01 maximum: 999999999999.99 description: fedBalance must be in the format of 999999999999.99 example: '123.45' overFedAdvantage: type: boolean format: boolean description: Indicates wire sent over FedAdvantage. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false autoGeneratedFromValueMessage: type: boolean format: boolean description: Indicates if the message was auto-generated as part of the validation process of a value message. modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true numAttempts: type: integer format: int64 minimum: 0 description: Number of attempts made to process the message. actions: type: object properties: retry: type: boolean description: Flag to indicate whether to retry processing the message. nullable: false sendOverFedAdvantage: type: boolean description: Flag to indicate whether to send the message over Fedline Advantage. nullable: false required: - retry - sendOverFedAdvantage originalCreationDateTime: type: string format: date-time description: The original creation date and time of the message. daysPrior: type: integer description: Number of days prior to the current date min=-2 to max=0. example: -2 startSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 endSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 requestType: type: string format: string enum: - Sent - Recv description: Identification assigned by an institution. example: Sent originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 parentMessageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 required: - messageId - messageDefinition - fedMessage - messageIdentification - status - fedCalendarCheck - fedConnectionCheck - fedBalanceCheck - createdBy - createdOn - actions paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/retrieval-request: post: operationId: RetrievalRequest tags: - Fedline Direct summary: API to submit a retrieval request [admi.006] description: Method to submit a retrieval request [admi.006]. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true description: Required fields for the endpoint content: application/json: schema: type: object properties: msgRtType: type: string format: string enum: - Sent - Recv description: Identification assigned by an institution. example: Sent wireMsgCode: type: string format: string description: Original message definition. example: pacs.008.001.08 startSeqNum: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 endSeqNum: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalCreationDateTime: type: string format: date-time description: The original creation date and time of the message to be retrieved. daysPrior: type: integer minimum: -2 maximum: 0 description: Number of days prior to the current date min=-2 to max=0. example: 0 required: - msgRtType - originalCreationDateTime anyOf: - required: - wireMsgCode - startSeqNum - endSeqNum - required: - wireMsgCode - messageIdentification responses: '200': description: Ok content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/outgoing-messages/{MessageId}: get: operationId: ViewOutgoingFedlineDirectMessage tags: - Fedline Direct summary: API to retrieve Outgoing Fedline Direct Message by MessageId description: Method to view an Outgoing Fedline Direct message by MessageId. responses: '200': description: Ok content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). status: type: string format: string enum: - Processing - Complete - Failed - Rejected statusReason: type: string format: string description: Reason for the current status of the outgoing message. expectedExecutionDateTime: type: string format: date-time description: The date and time when the wire is expected to be processed. fedCalendarCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Calendar Check. fedCalendarCheckComments: type: string format: string description: Comments regarding the Federal Calendar Check. fedCalendarDateTime: type: string format: date-time description: The date and time when the Fed calendar check was performed. fedConnectionCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: status on fed connection check. fedConnectionCheckComments: type: string format: string description: Comments regarding the fed connection check. fedConnectionExpectedDateTime: type: string format: date-time description: The date and time when the fed connect check expected. fedBalanceCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Balance Check. fedBalanceCheckComments: type: string format: string description: Comments regarding the Federal Balance Check. fedBalanceExcutionDateTime: type: string format: date-time description: The date and time when the Federal Balance Check was executed. fedBalance: type: string format: number minimum: 0.01 maximum: 999999999999.99 description: fedBalance must be in the format of 999999999999.99 example: '123.45' overFedAdvantage: type: boolean format: boolean description: Indicates wire sent over FedAdvantage. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false autoGeneratedFromValueMessage: type: boolean format: boolean description: Indicates if the message was auto-generated as part of the validation process of a value message. modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true numAttempts: type: integer format: int64 minimum: 0 description: Number of attempts made to process the message. actions: type: object properties: retry: type: boolean description: Flag to indicate whether to retry processing the message. nullable: false sendOverFedAdvantage: type: boolean description: Flag to indicate whether to send the message over Fedline Advantage. nullable: false required: - retry - sendOverFedAdvantage originalCreationDateTime: type: string format: date-time description: The original creation date and time of the message. daysPrior: type: integer description: Number of days prior to the current date min=-2 to max=0. example: -2 startSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 endSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 requestType: type: string format: string enum: - Sent - Recv description: Identification assigned by an institution. example: Sent originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 parentMessageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 required: - messageId - messageDefinition - fedMessage - messageIdentification - status - fedCalendarCheck - fedConnectionCheck - fedBalanceCheck - createdBy - createdOn - actions '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/outgoing-messages/{MessageId}/forward-over-fedline-advantage: post: operationId: ForwardOverFedlineAdvantage tags: - Fedline Direct summary: API to forward an outgoing Fedline Direct message over Fedline Advantage description: Method to forward an outgoing Fedline Direct message over Fedline Advantage. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - name: skipRegenerateMessageIdentification in: query description: Flag to indicate whether to skip regenerating message identification in ISO message required: false schema: type: string format: boolean responses: '200': description: Ok content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/outgoing-messages/{MessageId}/resend: post: operationId: ResendFedlineDirectMessage tags: - Fedline Direct summary: API to resend an outgoing Fedline Direct message over directline. description: Method to resend an outgoing Fedline Direct message over directline. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: MessageId in: path description: A unique identifier to identity a message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Ok content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/connection: post: operationId: ConnectionCheck1 tags: - Fedline Direct summary: API to submit a connection check request [admi.004] description: Method to submit a connection check request [admi.004]. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: ConnectionCheck tags: - Fedline Direct summary: API to retrieve the latest connection information. description: Method to retrieve the latest connection information received for the FI (either admi.004 or admi.011). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Ok content: application/json: schema: type: object properties: eventCode: type: string format: string enum: - ADHC - CLSD - EXTN - OPEN description: Proprietary code used to specify an event that occurred in a system. eventDateTime: type: string format: date-time description: Date and time the last connection response was received from the fed. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/reports: post: operationId: ReportingRequest tags: - Fedline Direct summary: API to create a report request(camt.060). description: Method to create a report request(camt.060). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: reportIdentification: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT description: | Report identification. The value of this field is a code that indicates the type of report requested. The following values are supported: - ABAR: Account Balance Report - DTLR: Endpoint details received report - DTLS: Endpoint details sent report - ETOT: Endpoint Totals Report agentAccountType: type: string format: string enum: - M - S description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number reportSequence: type: object properties: from: type: string format: string pattern: '[0-9]{6,6}' description: The starting sequence number for the report. From Sequence must be less than or equal to sequence number in To Sequence. to: type: string format: string pattern: '[0-9]{6,6}' description: The ending sequence number for the report. To Sequence must be greater than or equal to sequence number in From Sequence. description: | Report sequence. This field is required of the Report Identification is DTLR or DTLS. required: - reportIdentification responses: '201': description: Ok content: application/json: schema: type: object properties: reportId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Report Id. messageIdentification: type: string format: string description: Message identification example: 123456 required: - reportId - messageIdentification '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: GetReportMessages tags: - Fedline Direct summary: API to get report messages(camt.060, camt.052). description: Method to get report messages(camt.060, camt.052). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: unsolicited in: query required: false description: Filter by reports that were given unsolicited example: '?unsolicited=true' schema: type: boolean format: boolean - name: statuses in: query required: false schema: type: array items: type: string format: string enum: - Completed - Rejected - Processing - name: agentAccountType in: query required: false description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number schema: type: string format: string enum: - M - S - name: reportIdentification in: query required: false description: Filter by reports that were given unsolicited example: '?reportIdentification=ABAR' schema: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT - name: startDate in: query required: false schema: type: string format: date example: '2025-01-01' - name: endDate in: query required: false schema: type: string format: date example: '2025-01-01' - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' responses: '200': description: Success content: application/json: schema: type: object properties: reports: type: array items: type: object properties: reportId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Report Id. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). reportIdentification: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT - ACTR - GAPR - ETOT description: | Report identification. The value of this field is a code that indicates the type of report. The following values are supported: - ABAR: Account Balance Report - DTLR: Endpoint details received report - DTLS: Endpoint details sent report - ETOT: Endpoint Totals Report - ACTR: Unsolicited Report - GAPR: Endpoint Gap - ETOT: Endpoint Total reportStatus: type: string format: string enum: - Processing - Complete description: | Report status. This field is required of the Report Identification is DTLR or DTLS. The following values are supported: - Processing: The report is being processed. - Complete: The report has been completed. agentAccountType: type: string format: string enum: - M - S description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number requestedBy: type: string description: User who requested the resource nullable: true requestedOn: type: string format: date-time description: Requested On ISO date format. nullable: true receivedOn: type: string format: date-time description: Received On ISO date format. nullable: true reportCount: type: integer rejected: type: boolean rejectedOn: type: string format: date-time description: Received On ISO date format. nullable: true rejection: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 reason: type: string date: type: string format: date-time description: type: string required: - reportId - messageIdentification - reportIdentification - reportStatus - unsolicited paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/{InstitutionUniversalId}/fedline-direct/reports/{reportId}: get: operationId: GetReportMessage tags: - Fedline Direct summary: API to get report message(camt.052). description: Method to get report message(camt.052). parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: reportId in: path required: true schema: type: string format: uuid - name: Accept in: header required: false description: The Accept header is used to determine the format of the report data. Use application/zip to receive the results enclosed in a ZIP file format schema: type: string nullable: true default: application/json example: application/zip responses: '200': description: Success content: application/json: schema: type: object properties: reportId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Report Id. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). reportIdentification: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT - ACTR - GAPR - ETOT description: | Report identification. The value of this field is a code that indicates the type of report. The following values are supported: - ABAR: Account Balance Report - DTLR: Endpoint details received report - DTLS: Endpoint details sent report - ETOT: Endpoint Totals Report - ACTR: Unsolicited Report - GAPR: Endpoint Gap - ETOT: Endpoint Total reportStatus: type: string format: string enum: - Processing - Complete description: | Report status. This field is required of the Report Identification is DTLR or DTLS. The following values are supported: - Processing: The report is being processed. - Complete: The report has been completed. agentAccountType: type: string format: string enum: - M - S description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number reportCount: type: integer reports: type: array items: type: object properties: identification: type: string format: string description: Unique identification, as assigned by the account servicer, to unambiguously identify the account report. reportSequence: type: object properties: from: type: string format: string pattern: '[0-9]{6,6}' description: The starting sequence number for the report. From Sequence must be less than or equal to sequence number in To Sequence. to: type: string format: string pattern: '[0-9]{6,6}' description: The ending sequence number for the report. To Sequence must be greater than or equal to sequence number in From Sequence. description: | Report sequence. This field is required of the Report Identification is DTLR or DTLS. messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 creationDate: type: string format: date-time description: Created On ISO date format. nullable: false account: type: object properties: identification: type: string format: string description: Identification assigned by an institution. transactionSummaries: type: object properties: totalEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. totalCreditEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. totalDebitEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. totalEntriesPerBankTx: type: array items: type: object properties: num: type: string format: string description: Number of individual entries for the bank transaction code. sum: type: string format: number description: Total of all individual entries included in the report. totalNet: type: object properties: amount: type: string format: number description: Resulting amount of the netted amounts for all debit and credit entries. creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT creditEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. debitEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. forecastIndicator: type: boolean format: bolean description: Indicates whether the bank transaction code is related to booked or forecast items. bankTransactionCode: type: object properties: domain: type: object properties: code: type: string format: string description: Specifies the business area of the underlying transaction. family: type: object properties: code: type: string format: string description: Specifies the family within a domain. subCode: type: string format: string description: Specifies the sub-product family within a specific family. proprietary: type: object properties: code: type: string format: string description: Proprietary bank transaction code to identify the underlying transaction. issuer: type: string format: string description: Identification of the issuer of the proprietary bank transaction code. availability: type: array items: type: array items: type: object properties: days: type: string format: string description: Indicates the number of float days attached to the balance. date: type: string format: date-time description: Identifies the actual availability date. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT additionalReportInformation: type: string format: string description: Additional Report Information entries: type: array items: type: object properties: amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT bankTransactionCode: type: object properties: domain: type: object properties: code: type: string format: string description: Specifies the business area of the underlying transaction. family: type: object properties: code: type: string format: string description: Specifies the family within a domain. subCode: type: string format: string description: Specifies the sub-product family within a specific family. proprietary: type: object properties: code: type: string format: string description: Proprietary bank transaction code to identify the underlying transaction. issuer: type: string format: string description: Identification of the issuer of the proprietary bank transaction code. availability: type: array items: type: object properties: days: type: string format: string description: Indicates the number of float days attached to the balance. date: type: string format: date-time description: Identifies the actual availability date. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT balances: type: array items: type: object properties: type: type: string format: string description: Specifies the nature of a balance. subType: type: string format: string description: Specifies the balance sub-type. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false date: type: string format: date-time description: Indicates the date (and time) of the balance. creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT creditLine: type: array items: type: object properties: included: type: boolean format: boolean description: Indicates whether or not the credit line is included in the balance. type: type: string format: string description: Type of the credit line provided when multiple credit lines may be provided. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false date: type: string format: date-time description: Date of the credit line provided when multiple credit lines may be provided. requestedBy: type: string description: User who requested the resource nullable: true requestedOn: type: string format: date-time description: Requested On ISO date format. nullable: true receivedOn: type: string format: date-time description: Received On ISO date format. nullable: true rejectedOn: type: string format: date-time description: Received On ISO date format. nullable: true rejection: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 reason: type: string date: type: string format: date-time description: type: string required: - reportId - messageIdentification - reportIdentification - reportStatus - receivedOn - reports application/zip: schema: type: string format: binary description: Returns a PDF file containing the Fed Messages '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/users/{UserId}/accounts/{AccountId}/consumer/transfer-request: post: operationId: AddConsumerCreditTransfer tags: - Consumer Wire Credit Transfers summary: Create a credit transfer initiation request (pain.001). description: Create a credit transfer initiation request (pain.001). parameters: - name: UserId in: path description: The Unique Identifier of the User. required: true schema: type: string - name: AccountId in: path description: Unique identifier for the account. required: true schema: type: string example: e518a9c3-0ec6-415d-8e2c-d1f4de0daa63 requestBody: required: true description: The record to be created. content: application/json: schema: type: object properties: debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. NOTE: Only one (1) transaction per request is currently supported. type: array minItems: 1 maxItems: 1 items: type: object properties: paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string description: Local Instrument Proprietary Code. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution creditorAgent: description: Financial institution servicing an account for the creditor. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - amount - instructedAgent - creditor - creditoAgent required: - debtor - creditTransferTransactionInformation responses: '201': description: Created content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/users/{UserId}/accounts/{AccountId}/consumer/transfer-request/{MessageId}: get: operationId: ViewConsumerCreditTransfer tags: - Consumer Wire Credit Transfers summary: View a credit transfer initiation request (pain.001). description: View a credit transfer initiation request (pain.001). parameters: - name: UserId in: path description: The Unique Identifier of the User. required: true schema: type: string - name: MessageId in: path description: Unique identifier to find the message. required: true schema: type: string format: uuid example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 - name: AccountId in: path description: Unique identifier for the account. required: true schema: type: string example: e518a9c3-0ec6-415d-8e2c-d1f4de0daa63 responses: '200': description: OK content: application/json: schema: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. messageDefinition: type: string format: string enum: - pain.001.001.12 description: Message Definition expresses the type of message being processed. example: pain.001.001.12 createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false requestedExecutionDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: ISO date format (YYYY-MM-DD). Date at which the initiating party requests the clearing agent to process the payment. This will be set as the date the request was initiated/transmitted for processing. example: '2024-10-08' initiatedOn: type: string format: date-time description: ISO date-time format. This is the date and time the message was initiated/transmitted for processing. example: '2024-10-08T00:00:00Z' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV transactionCount: type: integer format: int32 description: Number of individual transactions (pacs.008's) are included in the message. totalAmount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' debtor: type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. type: array minItems: 1 items: type: object properties: paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uetr paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string description: Local Instrument Proprietary Code. required: - localInstrumentProprietaryCode amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - paymentIdentification - paymentTypeInformation - amount - instructedAgent - creditorAgent - creditor required: - messageId - instructionId - uetr - approvalId - status - messageDefinition - createdBy - createdOn - debtor - debtorAgent - creditTransferTransactionInformation description: | The message is used to provide information about a credit transfer initiation request pain.001 '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/jh-wires/v2/users/{UserId}/consumer/transfer-requests: get: operationId: ListConsumerCreditTransfers tags: - Consumer Wire Credit Transfers summary: List consumer credit transfer initiation requests for a user (pain.001). description: List consumer credit transfer initiation requests for a user (pain.001). parameters: - name: UserId in: path description: The Unique Identifier of the User. required: true schema: type: string - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' schema: type: string default: '100' - name: status in: query description: Consumer Transfer Request Status required: false schema: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. - name: UETR in: query description: Universally unique identifier to provide an end-to-end reference of a payment transaction (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 - in: query name: dateRangeType description: Date range type. required: false schema: type: string enum: - createdOnDate - initiatedOnDate default: createdOnDate - in: query name: fromDate description: Start created/initiated date to retrieve transfer requests within a date range. If unspecified, fromDate defaults to 2010-01-01. required: false schema: type: string format: date example: '2010-01-01' - in: query name: toDate description: End created/initiated date to retrieve transfer requests within a date range. If unspecified, toDate defaults to today's date in UTC. required: false schema: type: string format: date example: '2022-09-30' - in: query name: minAmount description: Minimum amount required: false schema: type: integer format: int32 - in: query name: maxAmount description: Maximum amount required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: type: object required: - results - paging properties: results: type: array items: type: object properties: debtor: type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. type: array minItems: 1 items: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - uetr - amount messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 status: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. messageDefinition: type: string format: string enum: - pain.001.001.12 description: Message Definition expresses the type of message being processed. example: pain.001.001.12 createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false requestedExecutionDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: ISO date format (YYYY-MM-DD). Date at which the initiating party requests the clearing agent to process the payment. This will be set as the date the request was initiated/transmitted for processing. example: '2024-10-08' initiatedOn: type: string format: date-time description: ISO date-time format. This is the date and time the message was initiated/transmitted for processing. example: '2024-10-08T00:00:00Z' approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 required: - approvalId - messageId - status - messageDefinition - createdBy - createdOn paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': 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 clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error components: schemas: CurrencyType: type: object required: - value - currencyType properties: value: type: string description: The value of the currency. example: '1000.00' currencyType: type: string description: The type of currency. example: USD AbilitiesResponse: type: object required: - viewWires - addWire - debtorApprove - creditorApprove - creditorReject - debtorReject - nsfOverride - feeControl - wiresAdmin - drafts - viewDraft - manageDrafts - notifications - ofac - wireFile - createWireLimit - debtorLimit - viewReports properties: viewWires: type: boolean description: Ability to view wire list and details. addWire: type: boolean description: Ability to add wire. debtorApprove: type: boolean description: Ability to approve as debtor. creditorApprove: type: boolean description: Ability to approve as creditor. creditorReject: type: boolean description: Ability to reject as creditor. debtorReject: type: boolean description: Ability to reject as debtor. nsfOverride: type: boolean description: Ability to override NSF. feeControl: type: boolean description: Ability to control fees. wiresAdmin: type: boolean description: Ability to be a wires admin. drafts: type: boolean description: Ability to manage draft activity. viewDraft: type: boolean description: Ability to view draft activity. manageDrafts: type: boolean description: Ability to manage draft activity. notifications: type: boolean description: Ability to manage notification settings. ofac: type: boolean description: Ability to manage OFAC. wireFile: type: boolean description: Ability to manage wire files. createWireLimit: type: object description: The create wire limit. required: - value - currencyType properties: value: type: string description: The value of the currency. example: '1000.00' currencyType: type: string description: The type of currency. example: USD debtorLimit: type: object description: The debtor limit. required: - value - currencyType properties: value: type: string description: The value of the currency. example: '1000.00' currencyType: type: string description: The type of currency. example: USD viewReports: type: boolean description: Ability to view reports. CustomerCreditTransferRequest: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - agent - name - postalAddress debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. this defaults to creditor agent if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description required: - amount - creditor - debtor CustomerCreditTransferResponse: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. CustomerCreditTransferRequest1: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - agent - name - postalAddress debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - amount - creditor - debtor - instructedAgent FICreditTransferRequest: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. this defaults to creditor institution if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: The Local Instrument Proprietary Code can accept either BTRC or BTRD from the user. If the user does not specify a value, the system defaults to BTRC. For BTRC, a new UETR is generated by the system. For BTRD, the UETR from the original drawdown (PAIN.013) is required. wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information required: - amount - creditor - debtor ReturnWireRequest: type: object properties: returnReason: type: object properties: reasonCode: type: string format: string minLength: 1 maxLength: 4 enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: Return reason code should contain four alphanumeric character code from the ISO 20022 externalized ReturnReason1Code list additionalInfo: type: array items: type: string format: string minLength: 1 maxLength: 105 maxItems: 2 description: Further details on the return reason. required: - reasonCode glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - returnReason FICreditTransferResponse: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. ReturnWireResponse: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. FICreditTransferRequest1: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: The Local Instrument Proprietary Code can accept either BTRC or BTRD from the user. If the user does not specify a value, the system defaults to BTRC. For BTRC, a new UETR is generated by the system. For BTRD, the UETR from the original drawdown (PAIN.013) is required. wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - amount - creditor - debtor - instructedAgent WireDetailsResponse: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD nullable: false nullable: false approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer returned enum values are CRED, DEBT, SHAR, SLEV nullable: true creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline messageIdentifier: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentifier: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: nullable: false type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory sentOn: type: string format: date-time description: Sent On ISO date format. status: type: string format: string enum: - Processing - Complete - Rejected sanctionIds: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description wireDestination: type: string description: Wire Destination wireSource: type: string description: Wire Source wireId: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing supplementary: type: array items: type: object properties: key: type: string format: string value: type: string format: string createdBy: nullable: false type: string description: User who created the wire createdOn: nullable: false type: string format: date-time description: Created On ISO date format. steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed ListWiresResponse: type: object properties: wires: type: array items: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD nullable: false nullable: false approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer returned enum values are CRED, DEBT, SHAR, SLEV nullable: true creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline nullable: false instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' nullable: false interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code is default to USABA for domestic wires. memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline messageIdentifier: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentifier: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: nullable: false type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory sentOn: type: string format: date-time description: Sent On ISO date format. status: type: string format: string enum: - Processing - Complete - Rejected sanctionIds: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description wireDestination: type: string description: Wire Destination wireSource: type: string description: Wire Source wireId: nullable: false type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing supplementary: type: array items: type: object properties: key: type: string format: string value: type: string format: string createdBy: nullable: false type: string description: User who created the wire createdOn: nullable: false type: string format: date-time description: Created On ISO date format. steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination RawWireResponse: type: object properties: WireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. WireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 MessageIdentifier: type: string format: string description: Identifier for the message(IMAD) BusinessMessageIdentifier: type: string format: string description: Business identifier for the message(OMAD) DebtorId: type: string format: uuid description: Identifier for the debtor DebtorAccount: type: string format: string description: Account number of the debtor DebtorFIRouting: type: string format: string description: Routing information for the debtor's financial institution DebtorFIClearingCode: type: string format: string description: Clearing code for the debtor's financial institution CreditorId: type: string format: uuid description: Identifier for the creditor CreditorAccount: type: string format: string description: Account number of the creditor MarketPracticeIdentification: type: string format: string description: Market practice identification Amount: type: integer format: int64 description: Amount of the wire CurrencyType: type: string format: string description: Type of currency ChargeBearer: type: string format: string description: Bearer of the charges PaymentUETR: type: string format: uuid description: Unique End-to-End Transaction Reference PaymentProprietaryCode: type: string format: string description: Proprietary code for the payment SettlementMethod: type: string format: string description: Method of settlement SettlementCode: type: string format: string description: Code for the settlement InstructionIdentification: type: string format: string description: Identification for the instruction EndToEndIdentification: type: string format: string description: End-to-end identification SentOn: type: string format: date-time description: Date and time when the wire was sent InstructedAgentRouting: type: string format: string description: Routing information for the instructed agent InstructedAgentClearingCode: type: string format: string description: Clearing code for the instructed agent InstructedAgentId: type: string format: uuid description: Identifier for the instructed agent InstructingAgentRouting: type: string format: string description: Routing information for the instructing agent InstructingAgentClearingCode: type: string format: string description: Clearing code for the instructing agent InstructingAgentId: type: string format: uuid description: Identifier for the instructing agent IntermediaryAgentRouting: type: string format: string description: Routing information for the intermediary agent IntermediaryAgentClearingCode: type: string format: string description: Clearing code for the intermediary agent IntermediaryAgentId: type: string format: uuid description: Identifier for the intermediary agent DebtorAgentRouting: type: string format: string description: Routing information for the debtor's agent DebtorAgentClearingCode: type: string format: string description: Clearing code for the debtor's agent DebtorAgentId: type: string format: uuid description: Identifier for the debtor's agent CreditorAgentRouting: type: string format: string description: Routing information for the creditor's agent CreditorAgentClearingCode: type: string format: string description: Clearing code for the creditor's agent CreditorAgentId: type: string format: uuid description: Identifier for the creditor's agent CreditorFIRouting: type: string format: string description: Routing information for the creditor's financial institution CreditorFIClearingCode: type: string format: string description: Clearing code for the creditor's financial institution UnstructuredRemittanceInformation: type: string description: Unstructured remittance information CreatedBy: type: string description: User who created the wire nullable: false CreatedOn: type: string format: date-time description: Created On ISO date format. nullable: false ModifiedBy: type: string description: User who modified the wire nullable: true ModifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true FedMessageResponse: type: object properties: fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. CancelWireRequest: type: object properties: comments: type: string format: string description: Comments CancelWireResponse: type: object properties: message: type: string format: string description: Message example: Wire canceled successfully. ProcessWireRequest: type: object properties: fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 accountOnAnalysis: description: Account On Analysis example: false type: boolean format: boolean amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireSequenceId: type: string format: string pattern: '[IO]W\d{4}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])\d{6}' description: Wire Sequence Id. required: - fedMessage - account - amount - wireDefinition - wireSequenceId ProcessWireResponse: type: object properties: message: type: string format: string description: Message example: Wire queued successfully to process. WireStepStatusUpdateListRequest: type: object properties: steps: type: array items: type: object properties: step: type: string format: string enum: - AccountValidation - Approvals - Ofac - MoneyMovement - FedSend description: WireStep example: AccountValidation status: type: string format: string enum: - Passed - NotPassed - Bypassed description: WireStepStatus example: Passed comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments required: - step - status required: - activities RetryWireRequest: type: object properties: steps: type: array items: type: string format: string enum: - AccountValidation - Approvals - Ofac - MoneyMovement - FedSend description: WireStep example: AccountValidation description: List of steps to retry RetryWireResponse: type: object properties: message: type: string format: string description: Message example: Wire successfully queued to retry failed steps processing. WireStepStatusUpdateRequest: type: object properties: step: type: string format: string enum: - AccountValidation - Approvals - Ofac - MoneyMovement - FedSend description: WireStep example: AccountValidation status: type: string format: string enum: - Passed - NotPassed - Bypassed description: WireStepStatus example: Passed comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments required: - step - status WireStepStatusUpdateResponse: type: object properties: message: type: string format: string description: Message example: Wire step status updated successfully. BulkWireStatusRequest: type: object properties: wireIds: type: array items: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. description: List of wireIds nullable: false required: - wireIds BulkWireStatusResponse: type: object properties: wireStatuses: type: array items: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. nullable: false wireSequenceId: type: string format: string pattern: '[IO]W\d{4}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])\d{6}' description: Wire Sequence Id. nullable: false status: type: string format: string enum: - Processing - Complete - Failed - Canceled - Returned description: Wire Status nullable: false statusDescription: type: string format: string maxLength: 255 description: Wire Status Description nullable: false steps: type: array items: type: object properties: step: type: string format: string enum: - AccountValidation - Approvals - Ofac - MoneyMovement - FedSend description: WireStep example: AccountValidation status: type: string format: string enum: - InProcess - Passed - NotPassed description: List of wire statuses nullable: false WireStatusResponse: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. nullable: false wireSequenceId: type: string format: string pattern: '[IO]W\d{4}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])\d{6}' description: Wire Sequence Id. nullable: false status: type: string format: string enum: - Processing - Complete - Failed - Canceled - Returned description: Wire Status nullable: false statusDescription: type: string format: string maxLength: 255 description: Wire Status Description nullable: false steps: type: array items: type: object properties: step: type: string format: string enum: - AccountValidation - Approvals - Ofac - MoneyMovement - FedSend description: WireStep example: AccountValidation status: type: string format: string enum: - InProcess - Passed - NotPassed ViewProcessWireResponse: type: object properties: fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 accountOnAnalysis: description: Account On Analysis example: false type: boolean format: boolean amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireSequenceId: type: string format: string pattern: '[IO]W\d{4}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])\d{6}' description: Wire Sequence Id. required: - fedMessage - account - amount - wireDefinition - wireSequenceId IncomingMessageRequest: type: object properties: msgDefinitionIdentifier: type: string format: string description: Identifier for the message definition system-generated pattern: ^[a-z]{4,4}[.]{1,1}[0-9]{3,3}[.]{1,1}001[.]{1,1}[0-9]{2,2} example: pacs.008.001.08 fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. IncomingMessageResponse: type: object properties: instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 MessagesByUETRResponse: type: array items: type: object properties: messageId: type: string format: uuid description: Unique Message identifier status: type: string format: string enum: - Processing - Success - Failed transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object properties: accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed MessageWithSteps: type: object properties: messageId: type: string format: uuid description: Unique Message identifier status: type: string format: string enum: - Processing - Success - Failed transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object properties: accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed AppPain013Request: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - account paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - DRRB - DRRC description: Local Instrument Proprietary Code allowed to accept DRRB, DRRC from user, If user didnot provide, system default to DRRB remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory requestedExecutionDate: type: string format: date description: The requested execution date of the wire transfer. The date must be in the format YYYY-MM-DD. wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description initiatingParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress description: This field will be populated with Creditor information when the Initiating Party is not provided in the pain.013 message. required: - amount - creditor - debtor AddCamt056Request: oneOf: - type: object properties: caseId: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: description: The creator party is the person or organization that created the investigation case type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress cancellationReason: description: | The cancellation reason is the reason for the return request. If the reason code for a return request is 'NARR' (Narrative), then additionalInfo is mandatory. type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode required: - cancellationReason - creatorParty - type: object properties: caseId: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorAgent: description: | The creator agent is the financial institution that created return request. user can input name and postal address or system autofill based on the financial institution memberId. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution cancellationReason: description: | The cancellation reason is the reason for the return request. If the reason code for a return request is 'NARR' (Narrative), then additionalInfo is mandatory. type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode required: - cancellationReason - creatorAgent Camt056CreatorAgentRequired: type: object properties: caseId: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorAgent: description: | The creator agent is the financial institution that created return request. user can input name and postal address or system autofill based on the financial institution memberId. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution cancellationReason: description: | The cancellation reason is the reason for the return request. If the reason code for a return request is 'NARR' (Narrative), then additionalInfo is mandatory. type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode required: - cancellationReason - creatorAgent Camt056CreatorPartyRequired: type: object properties: caseId: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: description: The creator party is the person or organization that created the investigation case type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress cancellationReason: description: | The cancellation reason is the reason for the return request. If the reason code for a return request is 'NARR' (Narrative), then additionalInfo is mandatory. type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode required: - cancellationReason - creatorParty AddCamt029Request: type: object properties: cancellationReason: type: object properties: reasonCode: type: string format: string enum: - AC04 - ADAC - AGNT - AM04 - ARDT - ARPL - CUST - LEGL - NARR - NOAS - NOOR - PTNA - RQDA - WSEQ - IDMN - ACLR - AEXR - ARFR - ARJR - PATE - RR04 - RCAR - RCNR - RCPR - URTP description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC04 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the cancellation reason. required: - reasonCode status: type: string format: string enum: - CNCL - RJCR required: - status AddCamt110Request: type: object properties: requestorInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 investigationType: type: string format: string enum: - UTAP - CCNR - CONR - RQFI - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF - OTHR description: | Investigation type codes should contain a code from the ISO 20022 externalized InvestigationType1Code code list. example: UTAP responderAgent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution investigationData: type: array minItems: 1 items: type: object properties: reasonCode: type: string format: string enum: - RERE - SVLV - CAPU - REDT - ISDT - ISAM - AMNT - DTOR - DTAG - IGRA - IDRA - TDRA - INAG - PYCC - CTAG - CTOR - REIN - PYPU - CHBE - INNA - INCA - STET - SEAC - CHIN - ULTD - ULTC - PURP - INPA - REGR - TAXD - FRAD - FCCI - FWTR - CHCO - DRCO - AMLI - RQPR - RQVD - RQLD - RQSG - RQED - RQDO - CHNP - NARR - RQCD - UTAP - CCNR - CONR - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF description: | Reason codes should contain a code from the ISO 20022 externalized InvestigationReason1Code code list. example: RERE narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). required: - investigationType - responderAgent - investigationData AddCamt111Request: type: object properties: responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 investigationStatus: type: string format: string enum: - PDNG - RJCT - CLSD description: | The status of the investigation. This code indicates the current status of the investigation. investigationStatusReason: type: string format: string enum: - AGNT - DU01 - NARR - FTNA - CAPR - CACR - ADAC - ARPL - NOAS - INPO - NOOR - ARJT - ARDT - RR04 - LEGL - ESCA - INIT - PARE - NOAD description: | Status reason codes should contain a code from the ISO 20022 externalized InvestigationStatusReason1Code code list. example: AGNT investigationData: type: array minItems: 1 items: type: object properties: narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). required: - investigationStatus - investigationStatusReason - investigationData SingleMessage: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false messageIdentification: type: string format: string minLength: 1 maxLength: 35 description: Message Identification businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). overDirectLine: type: boolean format: boolean description: Indicates whether the message is sent over a direct line. example: true steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return required: - approvalId - uetr - messageId - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions MessageListResponse: type: object properties: messages: type: array items: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false messageIdentification: type: string format: string minLength: 1 maxLength: 35 description: Message Identification businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). overDirectLine: type: boolean format: boolean description: Indicates whether the message is sent over a direct line. example: true steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return required: - approvalId - uetr - messageId - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination MessageListCSVResponse: type: string example: |- MessageId,InstructionId,UETR,ApprovalId,Amount,Status,MessageDefinition,BusinessDefinition,TransactionType,CreatedBy,CreatedOn,Steps,Actions MSG123,INST123,550e8400-e29b-41d4-a716-446655440000,APPROVAL123,1000.00,ACCP,Pain.013,TypeA,Type1,user1,2023-10-01T12:00:00Z,"[{"step":"Initiated","timestamp":"2023-10-01T12:00:00Z"}]","[{"action":"Approved","timestamp":"2023-10-01T12:05:00Z"}]" MSG124,INST124,550e8400-e29b-41d4-a716-446655440001,APPROVAL124,2000.00,RJCT,Pain.014,TypeB,Type2,user2,2023-10-02T13:00:00Z,"[{"step":"Initiated","timestamp":"2023-10-02T13:00:00Z"}]","[{"action":"Rejected","timestamp":"2023-10-02T13:05:00Z"}]" description: CSV formatted string of message list AddPain014Request: type: object properties: transactionStatus: type: string format: string enum: - PDNG - RJCT - ACTC description: | The status of the transaction. This code indicates the current status of the transaction. statusReasonInformation: type: array items: type: object properties: reasonCode: type: string format: string enum: - AB01 - AB02 - AB03 - AB04 - AB05 - AB06 - AB07 - AB08 - AB09 - AB10 - AB11 - AC01 - AC02 - AC03 - AC04 - AC05 - AC06 - AC07 - AC08 - AC09 - AC10 - AC11 - AC12 - AC13 - AC14 - AC15 - AC16 - AG01 - AG02 - AG03 - AG04 - AG05 - AG06 - AG07 - AG08 - AG09 - AG10 - AG11 - AG12 - AG13 - AGNT - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - AM11 - AM12 - AM13 - AM14 - AM15 - AM16 - AM17 - AM18 - AM19 - AM20 - AM21 - AM22 - AM23 - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - BE09 - BE10 - BE11 - BE12 - BE13 - BE14 - BE15 - BE16 - BE17 - BE18 - BE19 - BE20 - BE21 - BE22 - BE23 - CERI - CH03 - CH04 - CH07 - CH09 - CH10 - CH11 - CH12 - CH13 - CH14 - CH15 - CH16 - CH17 - CH19 - CH20 - CH21 - CH22 - CHQC - CNOR - CURR - CUST - DNOR - DS01 - DS02 - DS03 - DS04 - DS05 - DS06 - DS07 - DS08 - DS09 - DS0A - DS0B - DS0C - DS0D - DS0E - DS0F - DS0G - DS0H - DS0K - DS10 - DS11 - DS12 - DS13 - DS14 - DS15 - DS16 - DS17 - DS18 - DS19 - DS20 - DS21 - DS22 - DS23 - DS24 - DS25 - DS26 - DS27 - DT01 - DT02 - DT03 - DT04 - DT05 - DT06 - DU01 - DU02 - DU03 - DU04 - DU05 - DUPL - ED01 - ED03 - ED05 - ED06 - ERIN - FF01 - FF02 - FF03 - FF04 - FF05 - FF06 - FF07 - FF08 - FF09 - FF10 - FF11 - G000 - G001 - G002 - G003 - G004 - G005 - G006 - ID01 - MD01 - MD02 - MD05 - MD06 - MD07 - MS02 - MS03 - NARR - NERI - RC01 - RC02 - RC03 - RC04 - RC05 - RC06 - RC07 - RC08 - RC09 - RC10 - RC11 - RC12 - RCON - RECI - RF01 - RR01 - RR02 - RR03 - RR04 - RR05 - RR06 - RR07 - RR08 - RR09 - RR10 - RR11 - RR12 - S000 - S001 - S002 - S003 - S004 - SL01 - SL02 - SL03 - SL11 - SL12 - SL13 - SL14 - TA01 - TD01 - TD02 - TD03 - TK01 - TK02 - TK03 - TK09 - TKCM - TKSG - TKSP - TKVE - TKXP - TM01 - TS01 - TS04 - CN01 - FOCR - FR01 - NOCM - NOAS - RUTA - UPAY - ALAC - AEXR - ARFR - ARJR - ATNS - EDTR - EDTL - FRAD - IEDT - IRNR - NOAR - NOPG - NRCH - RTNS - REPR - SPII - PINS - UCRD - FF12 - FF13 - DC02 - APAR description: | status reason codes should contain a code from the ISO 20022 externalized StatusReason1Code code list. example: AB01 proprietary: type: string format: string maxLength: 35 description: Proprietary code for the reason of the drawdown response. additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the drawdown response. required: - reasonCode - proprietary description: | The status reason information is required when the transaction status is RJCT(Rejected). The reason code and proprietary information provide details about the rejection. required: - transactionStatus AddNonValueMessageResponse: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. ViewPain014: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' initiatingParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress description: This is the person/entity that initiated the request for payment (pain.013). creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalBusinessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' paymentInformationIdentification: type: string format: string maxLength: 35 description: Payment information identification. transactionStatus: type: string format: string enum: - PDNG - RJCT - ACTC description: | The status of the transaction. This code indicates the current status of the transaction. transactionStatusReasonInformation: type: array items: type: object properties: reasonCode: type: string format: string enum: - AB01 - AB02 - AB03 - AB04 - AB05 - AB06 - AB07 - AB08 - AB09 - AB10 - AB11 - AC01 - AC02 - AC03 - AC04 - AC05 - AC06 - AC07 - AC08 - AC09 - AC10 - AC11 - AC12 - AC13 - AC14 - AC15 - AC16 - AG01 - AG02 - AG03 - AG04 - AG05 - AG06 - AG07 - AG08 - AG09 - AG10 - AG11 - AG12 - AG13 - AGNT - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - AM11 - AM12 - AM13 - AM14 - AM15 - AM16 - AM17 - AM18 - AM19 - AM20 - AM21 - AM22 - AM23 - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - BE09 - BE10 - BE11 - BE12 - BE13 - BE14 - BE15 - BE16 - BE17 - BE18 - BE19 - BE20 - BE21 - BE22 - BE23 - CERI - CH03 - CH04 - CH07 - CH09 - CH10 - CH11 - CH12 - CH13 - CH14 - CH15 - CH16 - CH17 - CH19 - CH20 - CH21 - CH22 - CHQC - CNOR - CURR - CUST - DNOR - DS01 - DS02 - DS03 - DS04 - DS05 - DS06 - DS07 - DS08 - DS09 - DS0A - DS0B - DS0C - DS0D - DS0E - DS0F - DS0G - DS0H - DS0K - DS10 - DS11 - DS12 - DS13 - DS14 - DS15 - DS16 - DS17 - DS18 - DS19 - DS20 - DS21 - DS22 - DS23 - DS24 - DS25 - DS26 - DS27 - DT01 - DT02 - DT03 - DT04 - DT05 - DT06 - DU01 - DU02 - DU03 - DU04 - DU05 - DUPL - ED01 - ED03 - ED05 - ED06 - ERIN - FF01 - FF02 - FF03 - FF04 - FF05 - FF06 - FF07 - FF08 - FF09 - FF10 - FF11 - G000 - G001 - G002 - G003 - G004 - G005 - G006 - ID01 - MD01 - MD02 - MD05 - MD06 - MD07 - MS02 - MS03 - NARR - NERI - RC01 - RC02 - RC03 - RC04 - RC05 - RC06 - RC07 - RC08 - RC09 - RC10 - RC11 - RC12 - RCON - RECI - RF01 - RR01 - RR02 - RR03 - RR04 - RR05 - RR06 - RR07 - RR08 - RR09 - RR10 - RR11 - RR12 - S000 - S001 - S002 - S003 - S004 - SL01 - SL02 - SL03 - SL11 - SL12 - SL13 - SL14 - TA01 - TD01 - TD02 - TD03 - TK01 - TK02 - TK03 - TK09 - TKCM - TKSG - TKSP - TKVE - TKXP - TM01 - TS01 - TS04 - CN01 - FOCR - FR01 - NOCM - NOAS - RUTA - UPAY - ALAC - AEXR - ARFR - ARJR - ATNS - EDTR - EDTL - FRAD - IEDT - IRNR - NOAR - NOPG - NRCH - RTNS - REPR - SPII - PINS - UCRD - FF12 - FF13 - DC02 - APAR description: | status reason codes should contain a code from the ISO 20022 externalized StatusReason1Code code list. example: AB01 proprietary: type: string format: string maxLength: 35 description: Proprietary code for the reason of the drawdown response. additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the drawdown response. required: - reasonCode - proprietary sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - initiatingParty - creditorAgent - debtorAgent - originalMessageIdentification - originalMessageDefinition - originalBusinessDefinition - originalSentOn - paymentInformationIdentification - transactionStatus - transactionStatusReasonInformation - fedMessage - sanctionReference description: | The Pain014 message is used to provide information about response of pain.013 ViewPain013: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress initiatingParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress description: This is the person/entity that initiated the request for payment (pain.013). creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution paymentInformationIdentification: type: string format: string maxLength: 35 description: Payment information identification. requestExecutionTime: type: string format: date-time description: | The time at which the request was executed. This is the timestamp of when the request was processed. example: '2025-01-01T12:00:00Z' paymentMethod: type: string format: string enum: - TRF description: | The payment method used for the transaction. This code indicates the type of payment method used for the transaction. example: TRF paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - DRRB - DRRC description: Local Instrument Proprietary Code allowed to accept DRRB, DRRC from user, If user didnot provide, system default to DRRB chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - creditor - debtor - initiatingParty - creditorAgent - debtorAgent - paymentInformationIdentification - requestExecutionTime - paymentMethod - paymentIdentification - paymentTypeInformation - chargeBearer - fedMessage - sanctionReference description: | The Pain013 message is used to provide information about the drawdown requested. ViewCamt056: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' assignerAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution assigneeAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution caseIdentification: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress creatorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress originalInterbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true cancellationReason: type: object properties: reasonCode: type: string format: string enum: - AC02 - AC03 - AGNT - AM09 - BE16 - COVR - CURR - CUST - CUTA - DS24 - DT01 - DUPL - FRAD - FRNA - FRTR - INDM - MODT - PAID - SVNR - SYAD - TECH - UPAY - ENUE - UAPA - NARR - INCR - BIAS - DRTP - WNTB - MD06 description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC02 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the request return response. required: - reasonCode fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: caseCreatorAgent: type: string format: uuid description: Reference to the case creator agent. caseCreatorEntity: type: string format: uuid description: Reference to the case creator party. originator: type: string format: uuid description: Reference to the originator. oneOf: - required: - caseCreatorAgent - required: - caseCreatorEntity required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - originalMessageIdentification - originalMessageDefinition - originalSentOn - assignerAgent - assigneeAgent - caseIdentification - creatorParty - creatorAgent - originalInterbankSettlementDate - cancellationReason - fedMessage - sanctionReference ViewCamt029: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. assignerAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution assigneeAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' resolvedCaseIdentification: type: string format: string minLength: 1 maxLength: 35 description: uniquely identifies the case example: D12340001 creatorParty: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - name - postalAddress creatorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress statusConfirmation: type: string format: string enum: - CNCL - RJCR - PDCR - PECR description: | The status of the transaction. This code indicates the current status of the transaction. cancellationReason: type: array items: type: object properties: reasonCode: type: string format: string enum: - AC04 - ADAC - AGNT - AM04 - ARDT - ARPL - CUST - LEGL - NARR - NOAS - NOOR - PTNA - RQDA - WSEQ - IDMN - ACLR - AEXR - ARFR - ARJR - PATE - RR04 - RCAR - RCNR - RCPR - URTP description: | Cancellation reason codes should contain a code from the ISO 20022 externalized CancellationReason1Code code list. example: AC04 proprietary: type: string format: string maxLength: 35 description: Proprietary code for the status reason. additionalInformation: type: string format: string maxLength: 105 description: Further details on the status reason. required: - reasonCode - proprietary - additionalInformation description: | If the reason code for a return request response is 'NARR' (Narrative), then the free-formatted reason must be provided in Additional Information. sanctionReference: type: object properties: caseCreatorAgent: type: string format: uuid description: Reference to the case creator agent. caseCreatorEntity: type: string format: uuid description: Reference to the case creator party. originator: type: string format: uuid description: Reference to the originator. required: - originator required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - fedMessage - assignerAgent - assigneeAgent - originalMessageIdentification - originalMessageDefinition - originalSentOn - resolvedCaseIdentification - creatorParty - creatorAgent - statusConfirmation - cancellationReason - sanctionReference ViewCamt110: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. investigationType: type: string format: string enum: - UTAP - CCNR - CONR - RQFI - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF - OTHR description: | Investigation type codes should contain a code from the ISO 20022 externalized InvestigationType1Code code list. example: UTAP requestorInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 requestorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution responderAgent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution investigationData: type: array minItems: 1 items: type: object properties: reasonCode: type: string format: string enum: - RERE - SVLV - CAPU - REDT - ISDT - ISAM - AMNT - DTOR - DTAG - IGRA - IDRA - TDRA - INAG - PYCC - CTAG - CTOR - REIN - PYPU - CHBE - INNA - INCA - STET - SEAC - CHIN - ULTD - ULTC - PURP - INPA - REGR - TAXD - FRAD - FCCI - FWTR - CHCO - DRCO - AMLI - RQPR - RQVD - RQLD - RQSG - RQED - RQDO - CHNP - NARR - RQCD - UTAP - CCNR - CONR - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF description: | Reason codes should contain a code from the ISO 20022 externalized InvestigationReason1Code code list. example: RERE narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). initiation: type: object properties: originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalUetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. originalInstructedAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' requestExecutionTime: type: string format: date-time description: | The time at which the request was executed. This is the timestamp of when the request was processed. example: '2025-01-01T12:00:00Z' required: - originalMessageIdentification - originalMessageDefinition - originalSentOn - originalUetr - requestExecutionTime interbank: type: object properties: originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalInterbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true originalInterbankSettlementAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' required: - originalMessageIdentification - originalMessageDefinition - originalSentOn required: - messageId - instructionId - uetr - approvalId - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - sentOn - fedMessage - investigationType - requestorAgent - responderAgent - investigationData - initiation - interbank ViewCamt111: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). investigationType: type: string format: string enum: - UTAP - CCNR - CONR - RQFI - PINC - RQVA - RQUF - RQDA - ACCT - RQCH - RIMF - OTHR description: | Investigation type codes should contain a code from the ISO 20022 externalized InvestigationType1Code code list. example: UTAP responderInvestigationId: type: string format: string maxLength: 35 description: Investigation identification. example: INV1234567890 investigationStatus: type: string format: string enum: - PDNG - RJCT - CLSD description: | The status of the investigation. This code indicates the current status of the investigation. investigationStatusReason: type: string format: string enum: - AGNT - DU01 - NARR - FTNA - CAPR - CACR - ADAC - ARPL - NOAS - INPO - NOOR - ARJT - ARDT - RR04 - LEGL - ESCA - INIT - PARE - NOAD description: | Status reason codes should contain a code from the ISO 20022 externalized InvestigationStatusReason1Code code list. example: AGNT investigationData: type: array minItems: 1 items: type: object properties: narrative: type: string format: string maxLength: 500 description: Provides additional information about the request in narrative form. required: - reasonCode description: | Contains the data returned in the investigation request. The narrative field is mandatory if the reason code is NARR (Narrative). requestorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution responderAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - sentOn - fedMessage - originalMessageIdentification - investigationType - responderInvestigationId - investigationStatus - requestorAgent - responderAgent ViewPacs028: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - fedMessage - originalMessageIdentification - originalMessageDefinition - originalSentOn - instructedAgent - instructingAgent ViewPacs002: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 1 maxLength: 35 description: Message Identification businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution transactionStatus: type: string format: string enum: - ACSC - PDNG - RJCT description: | If a transaction is successfully settled(ACSC), then Acceptance Date Time and Effective Interbank Settlement Date mandatory. If a transaction is pending or is rejected then the status reason information(s) mandatory. statusReasonInformation: type: array items: type: object properties: proprietary: type: string format: string maxLength: 35 description: Proprietary code for the status reason. additionalInformation: type: string format: string maxLength: 105 description: Further details on the status reason. required: - proprietary - additionalInformation description: | The status reason for the transaction. If a transaction is pending(PDNG) or is rejected(RJCT) then the reason(s) mandatory. acceptanceDateTime: type: string format: date-time description: | The date and time at which the transaction was accepted. This is the timestamp of when the transaction was accepted. example: '2025-01-01T12:00:00Z' interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - messageIdentification - businessMessageIdentification - sentOn - fedMessage - originalMessageIdentification - originalMessageDefinition - originalSentOn - instructedAgent - instructingAgent - transactionStatus ViewAdmi002: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. reference: type: string format: string maxLength: 35 description: This is the reference of the original message. reason: type: object properties: rejectingPartyReason: type: string format: string maxLength: 35 description: The reason for the rejection. rejectionDateTime: type: string format: date-time description: | The date and time at which the rejection occurred. This is the timestamp of when the rejection was processed. example: '2025-01-01T12:00:00Z' reasonDescription: type: string format: string maxLength: 350 description: The description of the reason for the rejection. required: - rejectingPartyReason - rejectionDateTime required: - messageId - instructionId - uetr - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - fedMessage - reference - reason ViewAdmi007: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return reference: type: string format: string maxLength: 35 description: This is the reference of the original message. originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 statusCode: type: string format: string enum: - TS01 description: | The code 'TS01' informs of a successful transmission, i.e., the Fedwire Service successfully processed the message and forwarded it to the intended Fedwire Funds participant / Receiver. fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. required: - messageId - instructionId - uetr - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - fedMessage - reference - statusCode - originalMessageDefinition - messageIdentification DraftCustomerCreditTransferRequest: type: object description: The draft customer credit transfer request all root fields are optional, if they are provided which validate as per the ISO 20022 schema. properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. this defaults to creditor agent if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: The Local Instrument Proprietary Code can accept either CTRC or CTRD from the user. If the user does not specify a value, the system defaults to CTRC. For CTRC, a new UETR is generated by the system. For CTRD, the UETR from the original drawdown (PAIN.013) is required. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems DraftCustomerCreditTransferResponse: type: object properties: draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. DraftFICreditTransferRequest: type: object description: The draft fi credit transfer request all root fields are optional, if they are provided which validate as per the ISO 20022 schema. properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering agent to process the payment. this defaults to creditor institution if user did not provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. Name and postalAddress are auto populate by system if user didn't provide. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: Local Instrument Proprietary Code allowed to accept BTRC, BTRD for Financial Institution wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems DraftFICreditTransferResponse: type: object properties: draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. DraftWireDetailsResponse: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory scheduleId: nullable: false type: string format: uuid description: Schedule Id example: 123e4567-e89b-12d3-a456-426614174000 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems ScheduleRequest: type: object properties: frequency: type: string format: string enum: - Minute - Hour - Day - Week - Month - Year - Once description: The frequency of the schedule example: Day repeat: type: integer format: int64 minimum: 1 maximum: 999 description: The number of times the schedule should repeat example: 1 startDateTime: type: string format: date-time description: The date and time the schedule should start example: '2024-10-08T00:00:00Z' endDateTime: type: string format: date-time description: The date and time the schedule should end example: '2024-12-31T23:59:59Z' daysOfMonth: type: array items: type: integer format: int64 minimum: 28 maximum: 31 maxItems: 2 description: 'The user can select the specified date of the month that a schedule repeats. This field is to clarify the desired monthly date when a future scheduling conflict is possible. “28” = run the schedule on the 28th. “29” = run the schedule on the 29th, or if that date does not exist in a month, the schedule should run on the nearest day prior (e.g.: Feb 28). “30” = run the schedule on the 30th, or if that date does not exist in a month, the schedule should run on the nearest day prior (e.g.: Feb 28 or 29). “31” = always run the schedule on the last day of the month.' example: - 28 timeZone: type: string format: string description: The time zone of the schedule. Timezone in IANA format e.g. America/New_York. example: America/New_York required: - frequency - startDateTime ScheduleResponse: type: object properties: scheduleId: type: string format: uuid description: Schedule Id example: 123e4567-e89b-12d3-a456-426614174000 frequency: type: string format: string enum: - Minute - Hour - Day - Week - Month - Year - Once description: The frequency of the schedule example: Day repeat: type: integer format: int64 minimum: 1 maximum: 999 description: The number of times the schedule should repeat example: 1 startDateTime: type: string format: date-time description: The date and time the schedule should start example: '2024-10-08T00:00:00Z' endDateTime: type: string format: date-time description: The date and time the schedule should end example: '2024-12-31T23:59:59Z' daysOfMonth: type: array items: type: integer format: int64 minimum: 28 maximum: 31 maxItems: 2 description: 'The user can select the specified date of the month that a schedule repeats. This field is to clarify the desired monthly date when a future scheduling conflict is possible. “28” = run the schedule on the 28th. “29” = run the schedule on the 29th, or if that date does not exist in a month, the schedule should run on the nearest day prior (e.g.: Feb 28). “30” = run the schedule on the 30th, or if that date does not exist in a month, the schedule should run on the nearest day prior (e.g.: Feb 28 or 29). “31” = always run the schedule on the last day of the month.' example: - 28 nextScheduleDateTime: type: string format: date-time description: The date and time the schedule should run next example: '2024-10-08T00:00:00Z' timeZone: type: string format: string description: The time zone of the schedule. Timezone in IANA format e.g. America/New_York. example: America/New_York required: - frequency - startDateTime - scheduleId DraftWireListResponse: type: object properties: wires: type: array items: type: object properties: amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' currencyType: type: string format: string minLength: 3 maxLength: 3 description: Currency Type example: USD chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: Account Id nullable: true agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code returned enum values are CTRC, CTRD, BTRC, BTRD nullable: false remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory scheduleId: nullable: false type: string format: uuid description: Schedule Id example: 123e4567-e89b-12d3-a456-426614174000 wireDefinition: nullable: false type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 wireDescription: type: string description: Wire Description draftWireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination CreateWireResponse: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. ConfigRequest: type: object properties: core: type: string format: string enum: - Symitar - Silverlake description: The core system name where the account is held. example: Symitar required: - core ConfigResponse: type: object properties: core: type: string format: string enum: - Symitar - Silverlake description: The core system name where the account is held. example: Symitar required: - core CustomerAccountValRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' required: - account CustomerAccountValResponse: type: object properties: isValid: type: boolean format: boolean description: Is Valid example: true accountOnAnalysis: description: Account On Analysis example: false type: boolean format: boolean relationships: type: array items: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Member Name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - isValid GeneralLedgerValRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId required: - account AccountValResponse: type: object properties: isValid: type: boolean format: boolean description: Is Valid example: true required: - isValid OverrideNsfRequest: type: object properties: comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 100 description: Comments OverrideNsfResponse: type: object properties: message: type: string format: string description: Message example: NSF override is successful. WireAccountVerificationRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing required: - account - amount - wireDefinition - transactionType WireAccountVerificationResponse: type: object properties: message: type: string format: string description: Message example: Wire queued for account validation. AccountSearchResponse: type: object properties: results: type: array items: type: object properties: accountId: type: string format: string description: Account Id example: D123456789000 accountNumber: type: string format: string description: Account Number example: '123456789' accountType: type: string format: string description: Account Type example: C availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Member Name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - accountId - accountNumber - accountType - name - relationshipCode - postalAddress AccountSearchInfo: type: object properties: accountId: type: string format: string description: Account Id example: D123456789000 accountNumber: type: string format: string description: Account Number example: '123456789' accountType: type: string format: string description: Account Type example: C availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Member Name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - accountId - accountNumber - accountType - name - relationshipCode - postalAddress ViewWireAccountVerificationResponse: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId accountType: type: string format: string enum: - Customer - GeneralLedger description: Account Type example: Customer amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' overrideFee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' isOverrideFee: type: boolean format: boolean description: Override NSF example: true overrideAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId accountOnAnalysis: description: Account On Analysis example: false type: boolean format: boolean isNSF: type: boolean format: boolean description: Override NSF example: true isOverrideNSF: type: boolean format: boolean description: Override NSF example: true overrideOfficer: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 36 description: Override Officer overrideReason: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 100 description: Override Reason comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments accountCheck: type: string format: string enum: - Passed - NotPassed - ByPassed description: Account Check example: Passed balanceCheck: type: string format: string enum: - Passed - NotPassed - ByPassed description: Balance Check example: Passed avlBalanceDuringVal: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdDate: type: string format: date-time description: Created On ISO date format. nullable: false createdBy: type: string description: User who created the wire nullable: false modifiedDate: type: string format: date-time description: Modified On ISO date format. nullable: true modifiedBy: type: string description: User who modified the wire nullable: true required: - account - amount - fee - wireDefinition - transactionType - accountCheck - balanceCheck - createdDate - createdBy OverrideWireFeeRequest: type: object properties: overrideFee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' alternateAccount: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId overrideOfficer: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 36 description: Override Officer overrideReason: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 100 description: Override Reason required: - overrideFee OverrideWireFeeResponse: type: object properties: message: type: string format: string description: Message example: Override wire fee is successful. WireEntityRequest: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline required: - name - postalAddress WireEntityResponse: type: object properties: entityId: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ViewWireEntityResponse: type: object properties: name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline WireEntitiesRequest: type: object properties: entityIds: type: array items: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 required: - entityIds WireEntitiesResponse: type: object properties: entities: type: array items: type: object description: Entity Information properties: entityId: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline required: - entityId - name - postalAddress SearchEntitiesResponse: type: object properties: entities: type: array items: type: object description: Entity Information properties: entityId: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline required: - entityId - name - postalAddress BatchWireEntitiesRequest: type: object properties: entities: type: array items: type: object description: Entity Information properties: entityId: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline required: - entityId - name - postalAddress required: - entities BatchWireEntitiesResponse: type: object properties: entities: type: object additionalProperties: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 description: Map of entity id to entity id BatchMultipleWireEntitiesResponse: type: object properties: entities: type: object additionalProperties: type: object properties: entityId: type: string format: uuid description: A unique identifier to find a entity. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 sanctionId: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 description: Map of entity id to entity id Permissions: type: object required: - sorId - permissionSets properties: sorId: type: string description: The optional System of Record (SOR) or product ID that needs approval. permissionSets: type: object description: The optional permission sets requiring approval. Key-value pairs where keys are permission names and values are booleans indicating whether the permission is granted. example: ApproveWires: true ViewBalances: false ApprovalRequest: type: object properties: status: type: string enum: - REJECTED - APPROVED comment: type: string description: A comment from the user. example: I approve this request. validationData: type: object description: A user defined object that will be validated against the approval request. Example, the wire amount must be validated on the approval. example: amount: 100 CreateApprovalRequest: type: object required: - consumerUserApprovalRequested - consumerUserApprovalRequired - numberOfConsumerApprovalsRequired - enterpriseUserApprovalRequired - enterpriseUserApprovalRequested - numberOfEnterpriseApprovalsRequired properties: numberOfConsumerApprovalsRequired: type: integer description: Number of consumer users involved. consumerUserApprovalRequested: type: array items: type: string format: uuid description: Consumer who have been requested to approve the item. consumerUserApprovalRequired: type: array items: type: string format: uuid description: Consumer who have approved the item. enterpriseUserApprovalRequired: type: array items: type: string format: uuid description: Enterprise Users who have approved the item. enterpriseUserApprovalRequested: type: array items: type: string format: uuid description: Enterprise User who has been requested to approve the item. permissions: type: object required: - sorId - permissionSets properties: sorId: type: string description: The optional System of Record (SOR) or product ID that needs approval. permissionSets: type: object description: The optional permission sets requiring approval. Key-value pairs where keys are permission names and values are booleans indicating whether the permission is granted. example: ApproveWires: true ViewBalances: false numberOfEnterpriseApprovalsRequired: type: integer description: Number of enterprise users involved. validationData: type: object description: A user defined object that will be validated against the approval request. Example, the wire amount must be validated on the approval. example: amount: 100 ApprovalResponse: type: object properties: id: type: string format: uuid description: ID of the created approval item. Approval: type: object required: - userId - approvalStatus - submittedAt properties: userId: type: string format: uuid description: The ID of the user. approvalStatus: type: string enum: - REJECTED - APPROVED description: The status of the approval. comment: type: string description: A comment from the user. example: I approve this request. submittedAt: type: string format: date-time description: The date and time the approval was submitted. ApprovalDetails: type: object required: - id - status - consumerUserApprovalRequired - enterpriseUserApprovalRequired - enterpriseApprovalTotalCount - consumerApprovalTotalCount properties: id: type: string format: uuid description: ID of the created approval request. status: type: string enum: - PENDING - REJECTED - APPROVED description: Status of the approval request. consumerUserApprovalRequested: type: array items: type: string format: uuid description: Consumers who have been requested to approve the item. consumerUserApprovalRequired: type: array items: type: string format: uuid description: Consumers who have approved the item. enterpriseUserApprovalRequired: type: array items: type: string format: uuid description: Enterprise Users who have approved the item. enterpriseUserApprovalRequested: type: array items: type: string format: uuid description: Enterprise User who has been requested to approve the item. consumerApprovals: type: array items: type: object required: - userId - approvalStatus - submittedAt properties: userId: type: string format: uuid description: The ID of the user. approvalStatus: type: string enum: - REJECTED - APPROVED description: The status of the approval. comment: type: string description: A comment from the user. example: I approve this request. submittedAt: type: string format: date-time description: The date and time the approval was submitted. enterpriseApprovals: type: array items: type: object required: - userId - approvalStatus - submittedAt properties: userId: type: string format: uuid description: The ID of the user. approvalStatus: type: string enum: - REJECTED - APPROVED description: The status of the approval. comment: type: string description: A comment from the user. example: I approve this request. submittedAt: type: string format: date-time description: The date and time the approval was submitted. enterpriseApprovalsRequired: type: integer description: Number of enterprise users involved. enterpriseApprovalTotalCount: type: integer description: Number of enterprise users involved. consumerApprovalsRequired: type: integer description: Number of consumer users involved. consumerApprovalTotalCount: type: integer description: Number of consumer users involved. comment: type: string description: Comments related to the approval request. bypassed: type: boolean description: Indicates if the approval was bypassed. extraData: type: object properties: groupId: type: string format: uuid description: ID of the associated group, if any. wireId: type: string format: uuid description: ID of the associated wire. description: Extra data about the approval. PaymentProcessRequest: type: object properties: fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 paymentUetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 required: - fedMessage - wireDefinition - paymentUetr - instructionId PaymentProcessResponse: type: object properties: message: type: string format: string description: Message example: Wire queued successfully to send. ViewPaymentProcessRequest: type: object properties: fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 required: - fedMessage - account - amount - wireDefinition - wireSequenceId MoveMoneyStatusUpdateListRequest: type: object properties: activities: type: array items: type: object properties: activity: type: string format: string enum: - ProcessAmount - ProcessFee - AccountAnalysis - FedSend description: Step example: ProcessAmount status: type: string format: string enum: - InProcess - Passed - NotPassed - ByPassed description: StepStatus example: Passed required: - activity - status required: - activities MoveMoneyStatusUpdateRequest: type: object properties: activity: type: string format: string enum: - ProcessAmount - ProcessFee - AccountAnalysis - FedSend description: Step example: ProcessAmount status: type: string format: string enum: - InProcess - Passed - NotPassed - ByPassed description: StepStatus example: Passed required: - activity - status MoveMoneyStatusUpdateResponse: type: object properties: message: type: string format: string description: Message example: Wire transaction status updated successfully. RetryWireRequest1: type: object properties: steps: type: array items: type: string format: string enum: - ProcessAmount - ProcessFee - AccountAnalysis - FedSend description: Step example: ProcessAmount description: List of steps to retry RetryWireResponse1: type: object properties: message: type: string format: string description: Message example: Wire queued successfully for processing. ViewMoneyMovementStatus: type: object properties: paymentUetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 messageIdentifier: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). sentOn: type: string format: date-time description: Sent On ISO date format. comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments steps: type: array items: type: object properties: step: type: string format: string enum: - ProcessAmount - ProcessFee - AccountAnalysis - FedSend description: Step example: ProcessAmount status: type: string format: string enum: - InProcess - Passed - NotPassed - ByPassed description: StepStatus example: Passed description: List of steps in the wire transaction ViewFedlineDirectConfig: type: object properties: institutionId: type: string format: uuid description: Institution ID example: a3badfa6-00eb-4b0f-9881-d9c6ba95ca8b lTerm: type: string format: string description: LTerm example: ABCDE789 fedlineDirect: type: boolean format: boolean description: Is Fedline Direct example: false executeFedBalance: type: boolean format: boolean description: Execute Fed Balance example: false masterRtId: type: string format: string description: Master Routing Id example: '123456789' subRtId: type: string format: string description: Sub Routing Id example: '987654321' consumerName: type: string format: string description: Consumer Name example: Consumer Name consumerProduct: type: string format: string description: Consumer Product example: Consumer Product required: - institutionId - fedlineMode - fedlineDirect - executeFedBalance UpdateFedlineDirectConfig: type: object properties: fedlineDirect: type: boolean description: Is Fedline Direct example: false executeFedBalance: type: boolean description: Execute Fed Balance example: false required: - fedlineDirect - executeFedBalance UpdateFedlineDirectConfigResp: type: object properties: message: type: string description: Fedline Config updated successfully. example: Fedline Config updated successfully. FeeRequest: type: object properties: feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false required: - feeCategory - fee - transactionType FeeResponse: type: object properties: feeId: type: string format: uuid description: Fee Id. example: 123e4567-e89b-12d3-a456-426614174000 feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false OverAllFeeResponse: type: array items: type: object properties: feeId: type: string format: uuid description: Fee Id. example: 123e4567-e89b-12d3-a456-426614174000 feeCategory: type: string format: string enum: - Regular - Return - Schedule description: Fee Category Regular fee used for all regular wires, Return fee used for all return wires, Schedule fee used for all templates which is Schedule for future date. example: Regular fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing requireApprovingOfficer: type: boolean format: boolean description: This flag is used to determine if waive fee requires an approving officer. Default value is false example: false SymxConfigRequest: type: object properties: deviceNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Number example: '20900' deviceType: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Type example: BANNO shareIdLength: type: integer format: int32 oneOf: - minimum: 2 maximum: 2 - minimum: 4 maximum: 4 description: Share Id length either 2 or 4 example: 2 version: type: string format: string description: Version example: '2020.01' required: - deviceNumber - deviceType - shareIdLength - version SymxConfigResponse: type: object properties: message: type: string format: string description: Message example: Symx Config record added successfully GeneralLedgerAccountInqRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId required: - account GeneralLedgerAccountInqResponse: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId CustomerAccountInqRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId required: - account ShareAnalysisRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId required: - account ShareAnalysisResponse: type: object properties: message: type: string format: string description: Message example: ShareAnalysis record added successfully CustomerAccountInqResponse: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId balance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' eligibleForWires: type: boolean format: boolean description: Account Eligible for Wires example: true accountStatus: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ description: The status of Account example: Active standardAnalysis: type: boolean format: boolean description: Standard Analysis example: true relationships: type: array items: type: object properties: memberName: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Member Name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country AddHoldRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remark: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 40 description: Remark example: OW2024042300007 required: - account - amount - fee AddHoldResponse: type: object properties: message: type: string format: string description: Message example: Add hold on account is successfull RemoveHoldRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId required: - account RemoveHoldResponse: type: object properties: message: type: string format: string description: Message example: Remove hold on account is successfull WithdrawAmountRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remark: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 40 description: Remark example: OW2024042300007 required: - account - amount WithdrawAmountGeneralLedgerRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remark: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 40 description: Remark example: OW2024042300007 required: - account - amount WithdrawAmountResponse: type: object properties: message: type: string format: string description: Message example: Withdraw Amount record added successfully WithdrawFeeRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ minimum: 0.01 maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' remark: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 40 description: Remark example: OW2024042300007 required: - account - fee WithdrawFeeResponse: type: object properties: message: type: string format: string description: Message example: Withdraw Fee record added successfully TransactionSettingRequest: type: object properties: serviceFeeCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Service Fee Code example: service fee code is 8 for the symitar core example: '8' transactionSourceCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Transaction source code example: transaction source code is M for the symitar core example: M outgoingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Outgoing Shared Analysis Code example: outgoing shared analysis code is 18 for the symitar core example: '18' incomingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Incoming Shared Analysis Code example: incoming shared analysis code is 17 for the symitar core example: '17' draft: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Share: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber generalLedger: type: object properties: Outgoing: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber required: - serviceFeeCode - transactionSourceCode - outgoingSharedAnalysisCode - incomingSharedAnalysisCode TransactionSettingResponse: type: object properties: serviceFeeCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Service Fee Code example: service fee code is 8 for the symitar core example: '8' transactionSourceCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Transaction source code example: transaction source code is M for the symitar core example: M outgoingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Outgoing Shared Analysis Code example: outgoing shared analysis code is 18 for the symitar core example: '18' incomingSharedAnalysisCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 10 description: | Incoming Shared Analysis Code example: incoming shared analysis code is 17 for the symitar core example: '17' draft: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Share: type: object properties: Outgoing: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: oneOf: - type: object properties: settlementGLCode: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 3 maxLength: 3 description: | Settlement GL Code example: settlement GL code is 123 example: '123' required: - settlementGLCode - type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber generalLedger: type: object properties: Outgoing: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber Incoming: type: object properties: settlementAccountNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 6 maxLength: 6 description: | Account Number example: account number is 123456 example: '123456' settlementAccountSuffix: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Account Suffix example: account suffix is 0000 example: '0000' settlementBranchNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 4 maxLength: 4 description: | Branch Number example: branch number is 0000 example: '0000' required: - settlementAccountNumber - settlementAccountSuffix - settlementBranchNumber ViewSymxConfigResponse: type: object properties: deviceNumber: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Number example: '20900' deviceType: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 20 description: Device Type example: BANNO shareIdLength: type: integer format: int32 oneOf: - minimum: 2 maximum: 2 - minimum: 4 maximum: 4 description: Share Id length either 2 or 4 example: 2 version: type: string format: string description: Version example: '2020.01' required: - deviceNumber - deviceType - shareIdLength - version DepositAmountRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remark: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 40 description: Remark example: OW2024042300007 required: - account - amount DepositAmountResponse: type: object properties: message: type: string format: string description: Message example: Deposit Amount record added successfully DepositAmountGeneralLedgerRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remark: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 40 description: Remark example: OW2024042300007 required: - account - amount SLCommonSettings: type: object properties: avlBalanceCalCode: type: string description: The code used to calculate the available balance. example: AVL_BALANCE maxLength: 50 minLength: 1 pattern: ^[A-Z0-9_]+$ useGLCostCenter: type: boolean description: Indicates whether the GL cost center is used. example: true useGLProductCode: type: boolean description: Indicates whether the GL product code is used. example: true valBalanceChecking: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceSavings: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceLoan: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceOverdraft: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available valBalanceClub: type: string description: The balance validation type. enum: - Available - Collected - Current example: Available allowedAcctTypes: type: array description: The allowed account types. items: type: string description: The allowed account type. enum: - Checking - Savings - Loan - Overdraft example: SAVINGS allowedRelations: type: array description: The allowed relationships. items: type: string description: The allowed relationship. enum: - P - J example: P createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true required: - avlBalanceCalCode - useGLCostCenter - useGLProductCode - valBalanceChecking - valBalanceSavings - valBalanceLoan - valBalanceOverdraft - valBalanceClub SLTransactionSettings: type: object properties: accountType: type: string description: The account type. enum: - Deposit - Savings - Loan - GeneralLedger example: Deposit transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing sourceCode: type: string description: The transaction source code. example: '@1' maxLength: 10 pattern: ^[A-Z0-9@]+$ sourceCodeDescription: type: string description: The transaction source code description. example: Source Code Description maxLength: 50 pattern: ^[A-Za-z0-9]+$ transactionCode: type: string description: The transaction code. example: '111' maxLength: 10 pattern: ^[A-Za-z0-9]+$ glInterfaceCode: type: string description: The GL interface code. example: GL Interface Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementAccountNumber: type: string description: The GL settlement account number. example: GL Settlement Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementBranchNumber: type: string description: The GL settlement branch number. example: GL Settlement Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCostCenter: type: string description: The GL settlement cost center. example: GL Settlement Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementProductCode: type: string description: The GL settlement product code. example: GL Settlement Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCode: type: string description: The GL settlement code. example: GL Settlement Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderAccountNumber: type: string description: The GL provider account number. example: GL Provider Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderBranchNumber: type: string description: The GL provider branch number. example: GL Provider Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCostCenter: type: string description: The GL provider cost center. example: GL Provider Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderProductCode: type: string description: The GL provider product code. example: GL Provider Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCode: type: string description: The GL provider code. example: GL Provider Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - accountType - transactionType - sourceCode - sourceCodeDescription - transactionCode - glInterfaceCode SLTransactionSettingsResponse: type: array items: type: object properties: accountType: type: string description: The account type. enum: - Deposit - Savings - Loan - GeneralLedger example: Deposit transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing sourceCode: type: string description: The transaction source code. example: '@1' maxLength: 10 pattern: ^[A-Z0-9@]+$ sourceCodeDescription: type: string description: The transaction source code description. example: Source Code Description maxLength: 50 pattern: ^[A-Za-z0-9]+$ transactionCode: type: string description: The transaction code. example: '111' maxLength: 10 pattern: ^[A-Za-z0-9]+$ glInterfaceCode: type: string description: The GL interface code. example: GL Interface Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementAccountNumber: type: string description: The GL settlement account number. example: GL Settlement Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glSettlementBranchNumber: type: string description: The GL settlement branch number. example: GL Settlement Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCostCenter: type: string description: The GL settlement cost center. example: GL Settlement Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementProductCode: type: string description: The GL settlement product code. example: GL Settlement Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glSettlementCode: type: string description: The GL settlement code. example: GL Settlement Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderAccountNumber: type: string description: The GL provider account number. example: GL Provider Account Number maxLength: 10 pattern: ^[A-Za-z0-9]+$ glProviderBranchNumber: type: string description: The GL provider branch number. example: GL Provider Branch Number maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCostCenter: type: string description: The GL provider cost center. example: GL Provider Cost Center maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderProductCode: type: string description: The GL provider product code. example: GL Provider Product Code maxLength: 4 pattern: ^[A-Za-z0-9]+$ glProviderCode: type: string description: The GL provider code. example: GL Provider Code maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - accountType - transactionType - sourceCode - sourceCodeDescription - transactionCode - glInterfaceCode AccountAnalysisRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing required: - account - wireDefinition - transactionType AccountAnalysisResponse: type: object properties: message: type: string format: string description: Message example: AccountAnalysis record added successfully CustomerAccountInqResponse1: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId balance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' eligibleForWires: type: boolean format: boolean description: Account Eligible for Wires example: true accountStatus: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ description: The status of Account example: Active standardAnalysis: type: boolean format: boolean description: Standard Analysis example: true relationships: type: array items: type: object properties: memberName: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Customer Name example: customer name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country WithdrawAmountRequest1: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - amount WithdrawAmountGeneralLedgerRequest1: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - amount WithdrawFeeRequest1: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId fee: type: string format: number pattern: ^\d{1,6}(\.\d{2})?$ minimum: 0.01 maximum: 999999.99 description: fee must be in the format of 999999.99 example: '123.45' wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - fee - WireDefinition - transactionType DepositAmountRequest1: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - amount DepositAmountGeneralLedgerRequest1: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - amount AccountSearchResponse1: type: object properties: results: type: array items: type: object properties: accountId: type: string format: string description: Account Id example: D123456789000 accountNumber: type: string format: string description: Account Number example: '123456789' accountType: type: string format: string description: Account Type example: D availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Customer Name example: customer name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country AccountSearchInfo1: type: object properties: accountId: type: string format: string description: Account Id example: D123456789000 accountNumber: type: string format: string description: Account Number example: '123456789' accountType: type: string format: string description: Account Type example: D availableBalance: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Customer Name example: customer name relationshipCode: type: string format: string enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only description: Account Relationship description. example: Primary postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country GlProviderOrSettlementRequest: type: object properties: accountType: type: string description: The account type. enum: - Deposit - Savings - Loan - GeneralLedger example: Deposit transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - transactionType - amount AddMemoResponse: type: object properties: message: type: string format: string description: Message example: Memo record added successfully DeleteMemoResponse: type: object properties: message: type: string format: string description: Message example: Memo record delete successfully AddMemoRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' remarks: type: array description: The remarks. items: type: string description: The remark. maxLength: 30 pattern: ^[A-Za-z0-9]+$ required: - account - amount DeleteMemoRequest: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId required: - account FeeCodeSetting: type: object properties: transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing feeCategory: type: string format: string description: The fee category. enum: - Regular - Return - Schedule example: Regular feeCode: type: string format: string description: The fee code. example: CN maxLength: 10 pattern: ^[A-Za-z0-9]+$ analysisCode: type: string format: string description: The analysis code. example: '100' maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - feeCode - feeCategory - feeAmount FeeCodeSettings: type: object properties: feeCodes: type: array items: description: The fee code settings. example: - transactionType: Outgoing feeCategory: Regular feeCode: CN analysisCode: '100' - transactionType: Incoming feeCategory: Return feeCode: CP analysisCode: '200' type: object properties: transactionType: type: string format: string description: The transaction type. enum: - Outgoing - Incoming example: Outgoing feeCategory: type: string format: string description: The fee category. enum: - Regular - Return - Schedule example: Regular feeCode: type: string format: string description: The fee code. example: CN maxLength: 10 pattern: ^[A-Za-z0-9]+$ analysisCode: type: string format: string description: The analysis code. example: '100' maxLength: 10 pattern: ^[A-Za-z0-9]+$ required: - feeCode - feeCategory - feeAmount MessagesByFileId: type: object properties: messages: type: array items: type: object properties: fileId: type: string format: uuid description: A unique identifier to identity a file. example: 123e4567-e89b-12d3-a456-426614174000 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. status: type: string format: string enum: - Processing - Complete - Rejected comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false IncomingMessage: type: object properties: fileId: type: string format: uuid description: A unique identifier to identity a file. example: 123e4567-e89b-12d3-a456-426614174000 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. wireDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. status: type: string format: string enum: - Processing - Complete - Rejected comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false GetIncomingFedlineDirectMessagesResponse: type: object properties: messages: type: array items: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. status: type: string format: string description: The status of the incoming message. enum: - Success - Processing - Failed comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false isDuplicate: type: boolean description: Indicates whether the message is a duplicate required: - fedMessage - createdOn - status paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination IncomingFedlineDirectMessage: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. status: type: string format: string description: The status of the incoming message. enum: - Success - Processing - Failed comments: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 255 description: Comments createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false isDuplicate: type: boolean description: Indicates whether the message is a duplicate required: - fedMessage - createdOn - status GetFedlineDirectSystemMessagesResponse: type: object properties: messages: type: array items: type: object properties: id: type: string format: uuid description: ID refers to the unique identifier for the specific admi message messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. type: type: string description: the type of admi message enum: - Info - Warn - Error isRead: type: string format: boolean description: Expresses whether the message has been processed or not example: true isMapped: type: string format: boolean description: Expresses whether the message is mapped to another message example: true mappedMessageId: type: string format: uuid description: Refers to the unique identifier for message the system message is linked to createdOn: type: string format: date-time description: Created On ISO date format. nullable: false createdBy: type: string description: User who created the wire nullable: false statusDetails: type: string format: string description: Additional info provided in the system message regarding its status. required: - id - fedMessage - type - createdBy - createdOn paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination FedlineDirectSystemMessage: type: object properties: id: type: string format: uuid description: ID refers to the unique identifier for the specific admi message messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. type: type: string description: the type of admi message enum: - Info - Warn - Error isRead: type: string format: boolean description: Expresses whether the message has been processed or not example: true isMapped: type: string format: boolean description: Expresses whether the message is mapped to another message example: true mappedMessageId: type: string format: uuid description: Refers to the unique identifier for message the system message is linked to createdOn: type: string format: date-time description: Created On ISO date format. nullable: false createdBy: type: string description: User who created the wire nullable: false statusDetails: type: string format: string description: Additional info provided in the system message regarding its status. required: - id - fedMessage - type - createdBy - createdOn ViewPacs008: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uETR paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: Local Instrument Proprietary Code. Possible values are CTRC and CTRD. If CTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. authType: type: string nullable: true glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditorAgent - debtorAgent - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - paymentIdentification - paymentTypeInformation - fedMessage description: | The message is used to provide information about response of pacs.008 ViewPacs009: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - financialInstitution - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uETR paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - BTRC - BTRD description: Local Instrument Proprietary Code. Possible values are BTRC and BTRD. If BTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. authType: type: string nullable: true glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - paymentIdentification - paymentTypeInformation - fedMessage description: | The message is used to provide information about response of pacs.009 ViewPacs004: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' returnedInterbankSettlementAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' returnInstructedAmount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedSend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed fedAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - fedSend - fedAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true originalPaymentIdentification: type: object properties: originalInstructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. originalEndToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. originalUETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - originalEndToEndIdentification - originalUETR originalPaymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD - BTRC - BTRD description: Local Instrument Proprietary Code. Possible values are CTRC, CTRD, BTRC and BTRD. If CTRD, BTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. originalMessageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 originalSentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' returnReasonInformation: description: Return Reason Information. This is used to provide the reason for the return of a payment. type: object properties: returnReason: type: object properties: reasonCode: type: string format: string enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: | Return reason codes should contain a code from the ISO 20022 externalized ReturnReason1Code code list. example: AC01 additionalInfo: type: array items: type: string format: string maxLength: 105 maxItems: 2 description: Further details on the drawdown response. required: - reasonCode required: - returnReason fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. sanctionReference: type: object properties: debtor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditor: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 debtorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 creditorAgent: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 intermediaryAgent1: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 message: type: string format: uuid description: A unique identifier to find a sanction result. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - messageId - instructionId - uetr - approvalId - amount - returnedInterbankSettlementAmount - returnInstructedAmount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - originalPaymentIdentification - originalPaymentTypeInformation - originalMessageIdentification - originalMessageDefinition - originalSentOn - returnReasonInformation - fedMessage description: | The message is used to provide information about response of pacs.004. uetr and original uetr both are same. ReturnWireRequest1: type: object properties: returnReason: type: object properties: reasonCode: type: string format: string minLength: 1 maxLength: 4 enum: - AC01 - AC03 - AC04 - AC06 - AC13 - AC14 - AC15 - AC16 - AC17 - AG01 - AG02 - AM01 - AM02 - AM03 - AM04 - AM05 - AM06 - AM07 - AM09 - AM10 - ARDT - BE01 - BE04 - BE05 - BE06 - BE07 - BE08 - CN01 - CNOR - CNPC - CURR - CUST - DNOR - DS28 - DT01 - DT02 - ED01 - ED03 - ED05 - EMVL - ERIN - FF05 - FOCR - FR01 - FRTR - MD01 - MD02 - MD06 - MD07 - MS02 - MS03 - NARR - NOAS - NOCM - NOOR - PINL - RC01 - RC07 - RF01 - RR01 - RR02 - RR03 - RR04 - RUTA - SL01 - SL02 - SL11 - SL12 - SL13 - SL14 - SP01 - SP02 - SVNR - TM01 - TRAC - UPAY - AGNT - FF06 - RC08 - BE11 - BE17 - AC02 - RR11 - BE10 - BE16 - RC11 - RR12 - FF03 - FF07 - FF04 - RR09 - RR05 - RR07 - RR08 - RR06 - AG07 - G004 - MD05 - AC07 - DC04 - RC04 - DT04 - DUPL - RC03 description: Return reason code should contain four alphanumeric character code from the ISO 20022 externalized ReturnReason1Code list additionalInfo: type: array items: type: string format: string minLength: 1 maxLength: 105 maxItems: 2 description: Further details on the return reason. required: - reasonCode glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems required: - returnReason description: | Request to create a payment return (pacs.004) message. ReturnWireResponse1: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - wireId - uetr description: | Response after creating a payment return (pacs.004) message. CreateDisclaimerResponse: type: array items: example: settingId: dacd9529-75fe-4663-84f1-285ad3d19451 type: object properties: settingId: type: string format: uuid description: Identifier for disclaimer that was created GetDisclaimerResponse: type: object properties: settingName: type: string description: Name of setting settingId: type: string format: uuid description: Identifier for disclaimer settingValue: type: string description: Value of the disclaimer createdOn: type: string format: date-time modifiedOn: type: string format: date-time example: settingId: dacd9529-75fe-4663-84f1-285ad3d19451 institutionId: a3badfa6-00eb-4b0f-9881-d9c6ba95ca8b settingName: disclaimers.disclaimer settingValue: example disclaimer text createdOn: '0001-01-01T00:00:00Z' modifiedOn: '0001-01-01T00:00:00Z' UpdateDisclaimerResponse: type: object properties: settingId: type: string format: uuid description: Identifier for disclaimer that was updated settingValue: type: string description: New disclaimer value example: settingId: a3badfa6-00eb-4b0f-9881-d9c6ba95ca8b settingValue: updated disclaimer text CreateSettingResponse: type: object properties: settingId: type: string format: uuid description: Setting identifier CreateSettingRequest: type: object properties: settingName: type: string description: Name of setting to create settingValue: type: string description: Value of the setting to create required: - settingName - settingValue UpdateSettingRequest: type: object properties: settingValue: type: string description: Value to change the specified setting to required: - settingValue UpdateSettingResponse: type: object properties: settingId: type: string format: uuid description: Identifier for setting that was updated settingValue: type: string description: New setting value Setting: type: object properties: settingId: type: string format: uuid institutionId: type: string format: uuid settingName: type: string settingValue: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time GetSettingsResponse: type: array items: type: object properties: settingId: type: string format: uuid institutionId: type: string format: uuid settingName: type: string settingValue: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time CreatedDisclaimer: type: object properties: settingId: type: string format: uuid description: Identifier for disclaimer that was created IncomingMessageRequest1: type: object properties: message: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. IncomingMessageResponse1: type: object properties: messageReference: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 GetOutgoingFedlineDirectMessagesResponse: type: object properties: messages: type: array items: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). status: type: string format: string enum: - Processing - Complete - Failed - Rejected statusReason: type: string format: string description: Reason for the current status of the outgoing message. expectedExecutionDateTime: type: string format: date-time description: The date and time when the wire is expected to be processed. fedCalendarCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Calendar Check. fedCalendarCheckComments: type: string format: string description: Comments regarding the Federal Calendar Check. fedCalendarDateTime: type: string format: date-time description: The date and time when the Fed calendar check was performed. fedConnectionCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: status on fed connection check. fedConnectionCheckComments: type: string format: string description: Comments regarding the fed connection check. fedConnectionExpectedDateTime: type: string format: date-time description: The date and time when the fed connect check expected. fedBalanceCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Balance Check. fedBalanceCheckComments: type: string format: string description: Comments regarding the Federal Balance Check. fedBalanceExcutionDateTime: type: string format: date-time description: The date and time when the Federal Balance Check was executed. fedBalance: type: string format: number minimum: 0.01 maximum: 999999999999.99 description: fedBalance must be in the format of 999999999999.99 example: '123.45' overFedAdvantage: type: boolean format: boolean description: Indicates wire sent over FedAdvantage. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false autoGeneratedFromValueMessage: type: boolean format: boolean description: Indicates if the message was auto-generated as part of the validation process of a value message. modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true numAttempts: type: integer format: int64 minimum: 0 description: Number of attempts made to process the message. actions: type: object properties: retry: type: boolean description: Flag to indicate whether to retry processing the message. nullable: false sendOverFedAdvantage: type: boolean description: Flag to indicate whether to send the message over Fedline Advantage. nullable: false required: - retry - sendOverFedAdvantage originalCreationDateTime: type: string format: date-time description: The original creation date and time of the message. daysPrior: type: integer description: Number of days prior to the current date min=-2 to max=0. example: -2 startSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 endSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 requestType: type: string format: string enum: - Sent - Recv description: Identification assigned by an institution. example: Sent originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 parentMessageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 required: - messageId - messageDefinition - fedMessage - messageIdentification - status - fedCalendarCheck - fedConnectionCheck - fedBalanceCheck - createdBy - createdOn - actions paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination OutgoingFedlineDirectMessage: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). status: type: string format: string enum: - Processing - Complete - Failed - Rejected statusReason: type: string format: string description: Reason for the current status of the outgoing message. expectedExecutionDateTime: type: string format: date-time description: The date and time when the wire is expected to be processed. fedCalendarCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Calendar Check. fedCalendarCheckComments: type: string format: string description: Comments regarding the Federal Calendar Check. fedCalendarDateTime: type: string format: date-time description: The date and time when the Fed calendar check was performed. fedConnectionCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: status on fed connection check. fedConnectionCheckComments: type: string format: string description: Comments regarding the fed connection check. fedConnectionExpectedDateTime: type: string format: date-time description: The date and time when the fed connect check expected. fedBalanceCheck: type: string format: string enum: - InProcess - Bypassed - NotPassed - Passed description: Status of the Federal Balance Check. fedBalanceCheckComments: type: string format: string description: Comments regarding the Federal Balance Check. fedBalanceExcutionDateTime: type: string format: date-time description: The date and time when the Federal Balance Check was executed. fedBalance: type: string format: number minimum: 0.01 maximum: 999999999999.99 description: fedBalance must be in the format of 999999999999.99 example: '123.45' overFedAdvantage: type: boolean format: boolean description: Indicates wire sent over FedAdvantage. createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false autoGeneratedFromValueMessage: type: boolean format: boolean description: Indicates if the message was auto-generated as part of the validation process of a value message. modifiedBy: type: string description: User who modified the wire nullable: true modifiedOn: type: string format: date-time description: Modified On ISO date format. nullable: true numAttempts: type: integer format: int64 minimum: 0 description: Number of attempts made to process the message. actions: type: object properties: retry: type: boolean description: Flag to indicate whether to retry processing the message. nullable: false sendOverFedAdvantage: type: boolean description: Flag to indicate whether to send the message over Fedline Advantage. nullable: false required: - retry - sendOverFedAdvantage originalCreationDateTime: type: string format: date-time description: The original creation date and time of the message. daysPrior: type: integer description: Number of days prior to the current date min=-2 to max=0. example: -2 startSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 endSequence: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 requestType: type: string format: string enum: - Sent - Recv description: Identification assigned by an institution. example: Sent originalMessageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 parentMessageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 required: - messageId - messageDefinition - fedMessage - messageIdentification - status - fedCalendarCheck - fedConnectionCheck - fedBalanceCheck - createdBy - createdOn - actions RetrievalRequest: type: object properties: msgRtType: type: string format: string enum: - Sent - Recv description: Identification assigned by an institution. example: Sent wireMsgCode: type: string format: string description: Original message definition. example: pacs.008.001.08 startSeqNum: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 endSeqNum: type: string format: string description: The sequence number for wires that can be used for ranges minLength: 6 maxLength: 6 example: 200006 messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). originalCreationDateTime: type: string format: date-time description: The original creation date and time of the message to be retrieved. daysPrior: type: integer minimum: -2 maximum: 0 description: Number of days prior to the current date min=-2 to max=0. example: 0 required: - msgRtType - originalCreationDateTime anyOf: - required: - wireMsgCode - startSeqNum - endSeqNum - required: - wireMsgCode - messageIdentification RetrievalRequestResponse: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 ForwardMessageResponse: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 ConnectionCheckResponse: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 GetConnectionCheckResponse: type: object properties: eventCode: type: string format: string enum: - ADHC - CLSD - EXTN - OPEN description: Proprietary code used to specify an event that occurred in a system. eventDateTime: type: string format: date-time description: Date and time the last connection response was received from the fed. ReportingRequest: type: object properties: reportIdentification: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT description: | Report identification. The value of this field is a code that indicates the type of report requested. The following values are supported: - ABAR: Account Balance Report - DTLR: Endpoint details received report - DTLS: Endpoint details sent report - ETOT: Endpoint Totals Report agentAccountType: type: string format: string enum: - M - S description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number reportSequence: type: object properties: from: type: string format: string pattern: '[0-9]{6,6}' description: The starting sequence number for the report. From Sequence must be less than or equal to sequence number in To Sequence. to: type: string format: string pattern: '[0-9]{6,6}' description: The ending sequence number for the report. To Sequence must be greater than or equal to sequence number in From Sequence. description: | Report sequence. This field is required of the Report Identification is DTLR or DTLS. required: - reportIdentification ReportingRequestResponse: type: object properties: reportId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Report Id. messageIdentification: type: string format: string description: Message identification example: 123456 required: - reportId - messageIdentification ListReportResponse: type: object properties: reports: type: array items: type: object properties: reportId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Report Id. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). reportIdentification: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT - ACTR - GAPR - ETOT description: | Report identification. The value of this field is a code that indicates the type of report. The following values are supported: - ABAR: Account Balance Report - DTLR: Endpoint details received report - DTLS: Endpoint details sent report - ETOT: Endpoint Totals Report - ACTR: Unsolicited Report - GAPR: Endpoint Gap - ETOT: Endpoint Total reportStatus: type: string format: string enum: - Processing - Complete description: | Report status. This field is required of the Report Identification is DTLR or DTLS. The following values are supported: - Processing: The report is being processed. - Complete: The report has been completed. agentAccountType: type: string format: string enum: - M - S description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number requestedBy: type: string description: User who requested the resource nullable: true requestedOn: type: string format: date-time description: Requested On ISO date format. nullable: true receivedOn: type: string format: date-time description: Received On ISO date format. nullable: true reportCount: type: integer rejected: type: boolean rejectedOn: type: string format: date-time description: Received On ISO date format. nullable: true rejection: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 reason: type: string date: type: string format: date-time description: type: string required: - reportId - messageIdentification - reportIdentification - reportStatus - unsolicited paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination ReportDetailResponse: type: object properties: reportId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Report Id. messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). reportIdentification: type: string format: string enum: - ABAR - DTLR - DTLS - ETOT - ACTR - GAPR - ETOT description: | Report identification. The value of this field is a code that indicates the type of report. The following values are supported: - ABAR: Account Balance Report - DTLR: Endpoint details received report - DTLS: Endpoint details sent report - ETOT: Endpoint Totals Report - ACTR: Unsolicited Report - GAPR: Endpoint Gap - ETOT: Endpoint Total reportStatus: type: string format: string enum: - Processing - Complete description: | Report status. This field is required of the Report Identification is DTLR or DTLS. The following values are supported: - Processing: The report is being processed. - Complete: The report has been completed. agentAccountType: type: string format: string enum: - M - S description: | Agent account type. This is required if the Report Identification is ABAR. The following values are supported: - M: Master Account - S: Single Routing Number reportCount: type: integer reports: type: array items: type: object properties: identification: type: string format: string description: Unique identification, as assigned by the account servicer, to unambiguously identify the account report. reportSequence: type: object properties: from: type: string format: string pattern: '[0-9]{6,6}' description: The starting sequence number for the report. From Sequence must be less than or equal to sequence number in To Sequence. to: type: string format: string pattern: '[0-9]{6,6}' description: The ending sequence number for the report. To Sequence must be greater than or equal to sequence number in From Sequence. description: | Report sequence. This field is required of the Report Identification is DTLR or DTLS. messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 creationDate: type: string format: date-time description: Created On ISO date format. nullable: false account: type: object properties: identification: type: string format: string description: Identification assigned by an institution. transactionSummaries: type: object properties: totalEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. totalCreditEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. totalDebitEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. totalEntriesPerBankTx: type: array items: type: object properties: num: type: string format: string description: Number of individual entries for the bank transaction code. sum: type: string format: number description: Total of all individual entries included in the report. totalNet: type: object properties: amount: type: string format: number description: Resulting amount of the netted amounts for all debit and credit entries. creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT creditEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. debitEntries: type: object properties: num: type: string format: string description: Number of individual entries included in the report. sum: type: string format: number description: Total of all individual entries included in the report. forecastIndicator: type: boolean format: bolean description: Indicates whether the bank transaction code is related to booked or forecast items. bankTransactionCode: type: object properties: domain: type: object properties: code: type: string format: string description: Specifies the business area of the underlying transaction. family: type: object properties: code: type: string format: string description: Specifies the family within a domain. subCode: type: string format: string description: Specifies the sub-product family within a specific family. proprietary: type: object properties: code: type: string format: string description: Proprietary bank transaction code to identify the underlying transaction. issuer: type: string format: string description: Identification of the issuer of the proprietary bank transaction code. availability: type: array items: type: array items: type: object properties: days: type: string format: string description: Indicates the number of float days attached to the balance. date: type: string format: date-time description: Identifies the actual availability date. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT additionalReportInformation: type: string format: string description: Additional Report Information entries: type: array items: type: object properties: amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT bankTransactionCode: type: object properties: domain: type: object properties: code: type: string format: string description: Specifies the business area of the underlying transaction. family: type: object properties: code: type: string format: string description: Specifies the family within a domain. subCode: type: string format: string description: Specifies the sub-product family within a specific family. proprietary: type: object properties: code: type: string format: string description: Proprietary bank transaction code to identify the underlying transaction. issuer: type: string format: string description: Identification of the issuer of the proprietary bank transaction code. availability: type: array items: type: object properties: days: type: string format: string description: Indicates the number of float days attached to the balance. date: type: string format: date-time description: Identifies the actual availability date. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT balances: type: array items: type: object properties: type: type: string format: string description: Specifies the nature of a balance. subType: type: string format: string description: Specifies the balance sub-type. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false date: type: string format: date-time description: Indicates the date (and time) of the balance. creditOrDebit: type: string format: string description: Credit or Debit enum: - CRDT - DBIT creditLine: type: array items: type: object properties: included: type: boolean format: boolean description: Indicates whether or not the credit line is included in the balance. type: type: string format: string description: Type of the credit line provided when multiple credit lines may be provided. amount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false date: type: string format: date-time description: Date of the credit line provided when multiple credit lines may be provided. requestedBy: type: string description: User who requested the resource nullable: true requestedOn: type: string format: date-time description: Requested On ISO date format. nullable: true receivedOn: type: string format: date-time description: Received On ISO date format. nullable: true rejectedOn: type: string format: date-time description: Received On ISO date format. nullable: true rejection: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 reason: type: string date: type: string format: date-time description: type: string required: - reportId - messageIdentification - reportIdentification - reportStatus - receivedOn - reports TransferRequestCreate: type: object properties: debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. NOTE: Only one (1) transaction per request is currently supported. type: array minItems: 1 maxItems: 1 items: type: object properties: paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string description: Local Instrument Proprietary Code. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution creditorAgent: description: Financial institution servicing an account for the creditor. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - amount - instructedAgent - creditor - creditoAgent required: - debtor - creditTransferTransactionInformation CreditTransferTransactionInformationDetailRequest: type: object properties: paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string description: Local Instrument Proprietary Code. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' instructedAgent: description: The instructed agent is the financial institution that is instructed by the ordering party to process the payment. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId required: - financialInstitution intermediaryAgent1: description: The intermediary agent 1 is the financial institution that is the first intermediary in the payment chain. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution creditorAgent: description: Financial institution servicing an account for the creditor. type: object properties: financialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - amount - instructedAgent - creditor - creditoAgent TransferRequestCreateResponse: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 TransferRequestInitiationResponse: type: object properties: confirmationId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier confirmation of transfer request initiation example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 TransferRequestsList: type: object required: - results - paging properties: results: type: array items: type: object properties: debtor: type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. type: array minItems: 1 items: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - uetr - amount messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 status: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. messageDefinition: type: string format: string enum: - pain.001.001.12 description: Message Definition expresses the type of message being processed. example: pain.001.001.12 createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false requestedExecutionDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: ISO date format (YYYY-MM-DD). Date at which the initiating party requests the clearing agent to process the payment. This will be set as the date the request was initiated/transmitted for processing. example: '2024-10-08' initiatedOn: type: string format: date-time description: ISO date-time format. This is the date and time the message was initiated/transmitted for processing. example: '2024-10-08T00:00:00Z' approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 required: - approvalId - messageId - status - messageDefinition - createdBy - createdOn paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination TransferRequestListSingle: type: object properties: debtor: type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. type: array minItems: 1 items: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - uetr - amount messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 status: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. messageDefinition: type: string format: string enum: - pain.001.001.12 description: Message Definition expresses the type of message being processed. example: pain.001.001.12 createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false requestedExecutionDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: ISO date format (YYYY-MM-DD). Date at which the initiating party requests the clearing agent to process the payment. This will be set as the date the request was initiated/transmitted for processing. example: '2024-10-08' initiatedOn: type: string format: date-time description: ISO date-time format. This is the date and time the message was initiated/transmitted for processing. example: '2024-10-08T00:00:00Z' approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 required: - approvalId - messageId - status - messageDefinition - createdBy - createdOn CreditTransferTransactionInformationDetailList: type: object properties: uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - uetr - amount ViewPain001: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 status: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. messageDefinition: type: string format: string enum: - pain.001.001.12 description: Message Definition expresses the type of message being processed. example: pain.001.001.12 createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false requestedExecutionDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: ISO date format (YYYY-MM-DD). Date at which the initiating party requests the clearing agent to process the payment. This will be set as the date the request was initiated/transmitted for processing. example: '2024-10-08' initiatedOn: type: string format: date-time description: ISO date-time format. This is the date and time the message was initiated/transmitted for processing. example: '2024-10-08T00:00:00Z' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV transactionCount: type: integer format: int32 description: Number of individual transactions (pacs.008's) are included in the message. totalAmount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' debtor: type: object properties: account: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditTransferTransactionInformation: description: | Provides information on the individual transaction(s) included in the message. type: array minItems: 1 items: type: object properties: paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uetr paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string description: Local Instrument Proprietary Code. required: - localInstrumentProprietaryCode amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - paymentIdentification - paymentTypeInformation - amount - instructedAgent - creditorAgent - creditor required: - messageId - instructionId - uetr - approvalId - status - messageDefinition - createdBy - createdOn - debtor - debtorAgent - creditTransferTransactionInformation description: | The message is used to provide information about a credit transfer initiation request pain.001 CreditTransferTransactionInformationDetailView: type: object properties: paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uetr paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string description: Local Instrument Proprietary Code. required: - localInstrumentProprietaryCode amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory transactionDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 35 description: User provided name or description for the transaction. Flows to the WireDescription of a Pacs.008 required: - paymentIdentification - paymentTypeInformation - amount - instructedAgent - creditorAgent - creditor ViewABAFinancialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' ViewCreditorSideFinancialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' MessageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 InstructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. EndToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. UETR: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. AccountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 ApprovalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 Amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' AmountCents: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' CustomerAccount: type: object properties: accountId: type: string format: uuid minLength: 1 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}' description: Consumer Account Id example: 123e4567-e89b-12d3-a456-426614174000 required: - accountId CreditorCustomerAccount: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId Name: type: string format: string minLength: 1 maxLength: 140 description: Name StructuredAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country FinancialInstitutionABA: type: object properties: memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - memberId IntermediaryFinancialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId CreditorFinancialInstitution: type: object properties: memberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' required: - memberId FinancialInstitutionMemberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' CreditorFinancialInstitutionMemberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' IntermediaryFinancialInstitutionMemberId: type: string format: string minLength: 1 maxLength: 35 description: Financial Institution Member Id example: '123456789' ClearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA CreatedBy: type: string description: User who created the wire nullable: false CreatedOn: type: string format: date-time description: Created On ISO date format. nullable: false Paging: type: object properties: nextOffset: type: string format: string description: The next offset is the start position of the read pointer for pagination results: type: integer format: int64 description: The number of records sent for pagination total: type: integer format: int64 description: The total number of records requested for pagination IntlCustomerCreditTransferCreateRequest: type: object properties: amount: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' chargeBearer: type: string format: string enum: - SHAR - CRED - DEBT - SLEV description: Charge Bearer is limited to only accepting SHAR from the user; if the user does not provide it, the system defaults to SHAR purposeOfPayment: type: string enum: - Purchase of Good(s) - Purchase of Professional Service(s) - Professional fees payment (i.e. legal accountant) - Payroll/Personnel payment - Payment for a loan or deposit - Bill payment (i.e. credit card utility) - Research and Development - Business venture (i.e. merger acquisition) - Intercompany payment - Charitable donation - Purchase of property / real estate - Estate settlement / Inheritance - Government related payment - Investment related payment - PaymentFamily Assistance - Medical Assistance - Medical Claim Reimbursement - Remittance of funds from e-commerce - IP Trademark Patent Work - Travel/Hospitality - Publisher - Royalties - Reimbursement payment - Winnings - Accommodation - Allowances - Commissions or Fees - Concept Insurance - Construction Services - Consulting fees - Dividend payouts - Employee Expenses - Expert Testimony - Family Assistance - Final Settlement - Financial Support and Aid - Gifts - Honorarium - Income Tax payment - Interest payment - Ministry Support - Other Disbursement - Partner payment - Personal payment - Purchase of Textile & Upholstery - Relocation expenses - Rent payment - Research Fees - Return Deposit - Salary Advance - Teaching services - Test payment - Translation services - Travel Expenses - Tuition Payment or Refund creditor: type: object properties: account: type: object properties: accountId: type: string format: string minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId agent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' iban: type: string pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$ minLength: 15 maxLength: 34 description: International Bank Account Number (IBAN) bicCode: type: string pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ minLength: 8 maxLength: 11 example: DEUDEFF500 description: SWIFT/BIC code (ISO 9362) - 8 or 11 characters name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MNT - MOP - MRU - MUR - MVR - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SRD - STN - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW required: - financialInstitution - currency name: type: string format: string minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - agent - name - postalAddress debtor: description: The debtor is the party that owes the payment to the creditor. Name and postalAddress are auto populate by system if user didnot provide. type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress paymentIdentification: description: | A unique identifier assigned to the payment for tracking purposes throughout the payment chain. The UETR is automatically populated by the system if not provided by the user. If the user supplies a UETR, it must match the original drawdown (pain.013) request in the system. type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: Local Instrument Proprietary Code. Possible values are CTRC and CTRD. If CTRD is used, the message must reference the original drawdown (pain.013) request UETR. remittanceInformation: type: object properties: unstructured: type: string format: string maxLength: 140 description: Unstructured Remittance Information is mandatory quoteDetails: type: object properties: originatorCurrency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MNT - MOP - MRU - MUR - MVR - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SRD - STN - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW creditorCountry: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BR - IO - VG - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CK - CR - CI - HR - CU - CW - CY - CZ - CD - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - GA - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - CG - RE - RO - RU - RW - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - KR - SS - ES - LK - BL - SH - KN - LC - MF - PM - VC - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - GM - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VI - WF - EH - YE - ZM - ZW creditorCurrency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MNT - MOP - MRU - MUR - MVR - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SRD - STN - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW creditorReceives: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' IntlCustomerCreditTransferCreateResponse: type: object properties: wireId: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Wire Id. debtorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Debtor Id. creditorReference: type: string format: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Creditor Id. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. IntlCustomerCreditTransferReadResponse: type: object properties: messageId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the message example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 instructionId: type: string format: $uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Unique identifier to find the instruction example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. approvalId: type: string format: uuid description: Approval Id example: 123e4567-e89b-12d3-a456-426614174000 amount: type: object properties: value: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' status: type: string format: string enum: - Processing - Complete - Rejected messageDefinition: type: string format: string enum: - pacs.008.001.08 - pacs.009.001.08 - pacs.004.001.10 - pain.013.001.07 - pain.014.001.07 - camt.056.001.08 - camt.029.001.09 - camt.110.001.01 - camt.111.001.01 - pacs.028.001.03 - pacs.002.001.10 - admi.002.001.01 - admi.007.001.01 - admi.004.001.02 - admi.006.001.01 - admi.011.001.01 - camt.052.001.08 - pain.001.001.12 - camt.060.001.05 description: Message Definition expresses the type of message being processed. example: pacs.008.001.08 businessDefinition: type: string format: string enum: - customer transfer - fi transfer - payment return - drawdown request - drawdown response - return request - return response - investigation request - investigation response - payment status request - payment status - message rejection - message acknowledgement - ping or broadcast - retrieval request - system response - account reporting - consumer transfer request - reporting request description: | Message Definition expresses the type of message being processed. The business definition is a more specific description of the message type. 1. pacs.008.001.08 - customer transfer 2. pacs.009.001.08 - fi transfer 3. pacs.004.001.10 - payment return 4. pain.013.001.07 - drawdown request 5. pain.014.001.07 - drawdown response 6. "camt.056.001.08" - return request 7. "camt.029.001.09" - return response 8. "camt.110.001.01" - investigation request 9. "camt.111.001.01" - investigation response 10. "pacs.028.001.03" - payment status request 11. "pacs.002.001.10" - payment status 12. "admi.002.001.01" - message rejection 14. "admi.007.001.01" - message acknowledgement 15. "admi.004.001.02" - ping or broadcast 16. "admi.006.001.01" - retrieval request 17. "admi.011.001.01" - system response 18. "camt.052.001.08" - account reporting 19. "pain.001.001.12" - consumer transfer request 20. "camt.060.001.05" - reporting request example: customer transfer wireDescription: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 description: Wire Description transactionType: type: string format: string enum: - Outgoing - Incoming description: Transaction Type is either Outgoing or Incoming. example: Outgoing createdBy: type: string description: User who created the wire nullable: false createdOn: type: string format: date-time description: Created On ISO date format. nullable: false steps: type: object description: A collection of the statuses each step is in for the international wire. properties: ofac: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed accountValidation: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed approvals: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed moneyMovement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed wiresend: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed paymentAcknowledgement: type: string description: Describes the status of a step in the wire validation process. enum: - InProcess - Passed - NotPassed - Bypassed required: - ofac - accountValidation - approvals - moneyMovement - wiresend - paymentAcknowledgement actions: type: object description: A collection of the actions that can be performed on the wire. properties: accept: type: boolean description: Accept the wire. example: true reject: type: boolean description: Reject the wire. example: true pending: type: boolean description: Pend the wire. example: true acknowledge: type: boolean description: Acknowledge the wire. example: true requestPaymentStatus: type: boolean description: Request payment status for the wire. example: true requestInvestigation: type: boolean description: Request investigation for the wire. example: true requestReturn: type: boolean description: Request return for the wire. example: true return: type: boolean description: Return the wire. example: true required: - accept - reject - pending - acknowledge - requestPaymentStatus - requestInvestigation - requestReturn - return messageIdentification: type: string format: string minLength: 22 maxLength: 22 pattern: '[0-9]{8}[A-Z0-9]{8}[0-9]{6}' description: Must be the Fedwire Funds Input Message Accountability Data (IMAD). businessMessageIdentification: type: string format: string minLength: 1 maxLength: 35 description: For successfully processed messages this is the Output Message Accountability Data (OMAD). sentOn: type: string format: date-time description: Sent On ISO date format. This is the date and time the outgoing message was sent to the Fedwire system on . This is the date and time the incoming message was received by the Fedwire system. example: '2024-10-08T00:00:00Z' debtorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - financialInstitution - name - postalAddress creditor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress creditorAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' iban: type: string pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$ minLength: 15 maxLength: 34 description: International Bank Account Number (IBAN) bicCode: type: string pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ minLength: 8 maxLength: 11 example: DEUDEFF500 description: SWIFT/BIC code (ISO 9362) - 8 or 11 characters name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MNT - MOP - MRU - MUR - MVR - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SRD - STN - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW required: - financialInstitution - name - postalAddress - currency debtor: type: object properties: account: type: object properties: accountId: type: string format: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 34 description: | Account Id e.g. Symitar: Customer: D12340001 combination of Core account Id:1234, account type: Draft, core ShareId: 0001, S12340000 where Core account Id:1234, account type: Share, core ShareId: 0000 GL: 12121200010002 combination of Core account Id: 121212, account suffix: 0001, branch number: 0002 Silverlake: Customer: D123 combination of Core account id: 123, account type: Deposit, S456 where Core account id: 456, account type: Savings, L789 where Core account id: 789, account type: Loan GL: G00100010920001002 combination of Core account type: G, branch number: 001, account Id: 0001092, cost center: 0001, product code: 002 example: D12340001 required: - accountId name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country required: - account - name - postalAddress instructedAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution instructingAgent: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' required: - financialInstitution interbankSettlementDate: type: string format: date pattern: ^\d{4}-\d{2}-\d{2}$ description: Interbank Settlement Date (YYYY-MM-DD). nullable: true paymentIdentification: type: object properties: instructionIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input Instruction Identification. endToEndIdentification: type: string format: string minLength: 1 maxLength: 35 description: User can input End to End Identification else system will place "NOTPROVIDED" value. uetr: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Universally unique identifier to provide an end-to-end reference of a payment transaction. required: - endToEndIdentification - uETR paymentTypeInformation: type: object properties: localInstrumentProprietaryCode: type: string format: string enum: - CTRC - CTRD description: Local Instrument Proprietary Code. Possible values are CTRC and CTRD. If CTRD is used, the message must reference the original drawdown (pain.013) request UETR. required: - localInstrumentProprietaryCode intermediaryAgent1: type: object properties: financialInstitution: type: object properties: clearingSystemIdCode: type: string format: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK description: Clearing System Id Code. example: USABA memberId: type: string format: string pattern: ^[0-9]{9}$ minLength: 9 maxLength: 9 description: Financial Institution Member Id example: '123456789' name: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 140 description: Name postalAddress: oneOf: - type: object properties: department: type: string format: string minLength: 1 maxLength: 70 description: The department name. subDepartment: type: string format: string minLength: 1 maxLength: 70 description: The sub-department name. streetName: type: string format: string minLength: 1 maxLength: 70 description: The street name. buildingNumber: type: string format: string minLength: 1 maxLength: 16 description: The building number. buildingName: type: string format: string minLength: 1 maxLength: 35 description: The building name. floor: type: string format: string minLength: 1 maxLength: 70 description: The floor. postBox: type: string format: string minLength: 1 maxLength: 16 description: The post box. room: type: string format: string minLength: 1 maxLength: 70 description: The room. postCode: type: string format: string minLength: 1 maxLength: 16 description: The post code. townName: type: string format: string minLength: 1 maxLength: 35 description: The town name. townLocationName: type: string format: string minLength: 1 maxLength: 35 description: The town location name. districtName: type: string format: string minLength: 1 maxLength: 35 description: The district name. countrySubDivision: type: string format: string minLength: 1 maxLength: 35 description: The country subdivision. country: type: string format: string minLength: 2 maxLength: 2 pattern: ^[A-Z]{2,2}$ enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: The country code. required: - townName - country - type: object properties: addressLine: type: array items: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ minLength: 1 maxLength: 35 maxItems: 3 description: The address lines. required: - addressline description: | Intermediary Agent 1 is optional. If provided, it must contain the financial institution, name, and postal address. remittanceInformation: type: object properties: unstructured: type: string format: string description: Unstructured Remittance Information is mandatory fedMessage: type: string format: string pattern: <\?xml.*\?>.* minLength: 1 maxLength: 999999 description: The ISO 20022 XML message that is sent to the fedwire system. wireReference: type: string format: uuid pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' description: Draft Wire Id. authType: type: string nullable: true glComment: type: string format: string pattern: ^[A-Za-z0-9\s.,'"#&/\\-]+$ maxLength: 30 description: GL Comment field for the GL Transaction sent to Core systems quoteDetails: type: object properties: originatorCurrency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MNT - MOP - MRU - MUR - MVR - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SRD - STN - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW creditorCountry: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BR - IO - VG - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CK - CR - CI - HR - CU - CW - CY - CZ - CD - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - GA - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - CG - RE - RO - RU - RW - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - KR - SS - ES - LK - BL - SH - KN - LC - MF - PM - VC - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - GM - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VI - WF - EH - YE - ZM - ZW creditorCurrency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - CAD - CDF - CHF - CLP - CNH - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MNT - MOP - MRU - MUR - MVR - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SRD - STN - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW creditorReceives: type: string format: number pattern: ^\d{1,12}(\.\d{2})?$ minimum: 0.01 maximum: 999999999999.99 description: Amount must be in the format of 999999999999.99 example: '123.45' regulatoryInformation: type: object properties: accountType: type: string beneficiaryTaxId: type: string agencyCode: type: string contactName: type: string required: - messageId - instructionId - uetr - approvalId - amount - status - messageDefinition - businessDefinition - transactionType - createdBy - createdOn - steps - actions - creditorAgent - debtorAgent - creditor - debtor - instructedAgent - instructingAgent - interbankSettlementDate - paymentIdentification - paymentTypeInformation - fedMessage - quoteDetails - regulatoryInformation description: | The message is used to provide information regarding the international pacs.008 parameters: ApprovalIdParam: in: path name: Id required: true schema: type: string format: uuid description: The ID of the approval. ConsumerUserIdParam: in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. EnterpriseUserIdParam: in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. approvalIdParam: in: path name: id required: true schema: type: string format: uuid description: The ID of the approval. EnterpriseUserIdParam1: in: path name: EnterpriseUserIdParam required: true schema: type: string format: uuid description: The ID of the enterprise user. Accept: name: Accept in: header required: false description: The Accept header is used to determine the format of the report data. Use application/zip to receive the results enclosed in a ZIP file format schema: type: string nullable: true default: application/json example: application/zip UserId: name: UserId in: path description: The Unique Identifier of the User. required: true schema: type: string MessageId: name: MessageId in: path description: Unique identifier to find the message. required: true schema: type: string format: uuid example: 5fa85f64-5717-4562-b3fc-2c963f66afa6 AccountId: name: AccountId in: path description: Unique identifier for the account. required: true schema: type: string example: e518a9c3-0ec6-415d-8e2c-d1f4de0daa63 UETRQuery: name: UETR in: query description: Universally unique identifier to provide an end-to-end reference of a payment transaction (as a query parameter). schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 StatusQuery: name: status in: query description: Consumer Transfer Request Status required: false schema: type: string format: string enum: - Complete - Processing - Rejected example: Initiated description: | Status indicates the current state of the transfer request. The status can bearer: 1. Processing - The transfer request is currently being processed. 2. Completed - Processing of the pain.001 transfer request has been completed successfully and all related pacs.008 messages have been created. 3. Rejected - The transfer request has been rejected due to a failure to create one or many of the related pacs.008 messages. securitySchemes: bearerAuth: description: OpenIDConnect JWT Token type: http scheme: bearer bearerFormat: JWT responses: BadRequest: description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true Unauthorized: description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. 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 clients identity is known to the server. NotFound: description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. UnexpectedError: description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error x-jh: publishing: type: Integration stage: prod isPublic: true group: Digital Core name: Wires

Please ignore this field