Rate Quote

openapi: 3.0.1 info: title: Rate Quote version: '1.0' description: '' servers: - url: https://{API_ENVIRONMENT}/jx-api variables: API_ENVIRONMENT: default: jxdmz.jackhenry.com tags: - name: Rate Quote description: Obtain a currency exchange quote to be used in a wire transfer paths: /v1/institutions/{institutionId}/environments/{institutionEnvironment}/products/{productCode}/internationalwires/iwire-transfer-orchestrator-service/quotes: post: tags: - Rate Quote summary: API endpoint to create a rate quote parameters: - name: institutionId in: path required: true schema: type: string - name: institutionEnvironment in: path description: >- The Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: productCode in: path description: The code as related to a product. required: true schema: type: string default: CSS - name: Content-Type in: header description: 'Content Type. Example: application/json' required: true schema: type: string - name: X-Request-Id in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string - name: X-Correlation-Id in: header description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as Authorization jwt unless the message is sent on-behalf-of this consumer product. Example: AuthenticationProductCredential: jwt:<GeneratedOidcJwt> required: true schema: type: string - name: x-css-correlation-id in: header description: CSS Correlation Id allowEmptyValue: true schema: type: string requestBody: description: Quote to be created content: application/json: schema: required: - amount - lockSide - paymentCurrency type: object properties: lockSide: enum: - Settlement - Payment type: string paymentCurrency: maxLength: 3 minLength: 0 pattern: ^[A-Z]*$ type: string amount: maximum: 999999999.99 minimum: 0.01 type: number format: double settlementCurrency: pattern: ^[USD]+$ type: string nullable: true additionalProperties: false text/json: schema: required: - amount - lockSide - paymentCurrency type: object properties: lockSide: enum: - Settlement - Payment type: string paymentCurrency: maxLength: 3 minLength: 0 pattern: ^[A-Z]*$ type: string amount: maximum: 999999999.99 minimum: 0.01 type: number format: double settlementCurrency: pattern: ^[USD]+$ type: string nullable: true additionalProperties: false application/*+json: schema: required: - amount - lockSide - paymentCurrency type: object properties: lockSide: enum: - Settlement - Payment type: string paymentCurrency: maxLength: 3 minLength: 0 pattern: ^[A-Z]*$ type: string amount: maximum: 999999999.99 minimum: 0.01 type: number format: double settlementCurrency: pattern: ^[USD]+$ type: string nullable: true additionalProperties: false responses: '201': description: Created content: application/json: schema: type: object properties: quoteId: type: string nullable: true originatorSends: type: number format: double beneficiaryReceives: type: number format: double originatorCurrency: type: string nullable: true beneficiaryCurrency: type: string nullable: true quoteTimestamp: type: string format: date-time expiryTimestamp: type: string format: date-time expiry: type: integer format: int32 expiryRemaining: type: integer format: int32 conversionFactors: type: array items: type: object properties: fromCurrency: type: string nullable: true toCurrency: type: string nullable: true rate: type: number format: double additionalProperties: false nullable: true additionalProperties: false '400': description: Bad Request content: application/json: schema: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false /v1/institutions/{institutionId}/environments/{institutionEnvironment}/products/{productCode}/internationalwires/iwire-transfer-orchestrator-service/quotes/{quoteId}: get: tags: - Rate Quote summary: API endpoint to get rate quote by Id parameters: - name: quoteId in: path required: true schema: type: string example: 17c07735dc4c4f318a33d573d02d9210 - name: institutionId in: path required: true schema: type: string - name: institutionEnvironment in: path description: >- The Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common. required: true schema: type: string default: PROD - name: productCode in: path description: The code as related to a product. required: true schema: type: string default: CSS - name: X-Request-Id in: header description: >- To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string - name: X-Correlation-Id in: header description: >- To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string - name: X-AuthenticationProductCredential in: header description: >- Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as Authorization jwt unless the message is sent on-behalf-of this consumer product. Example: AuthenticationProductCredential: jwt:<GeneratedOidcJwt> required: true schema: type: string - name: x-css-correlation-id in: header description: CSS Correlation Id allowEmptyValue: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: quoteId: type: string nullable: true originatorSends: type: number format: double beneficiaryReceives: type: number format: double originatorCurrency: type: string nullable: true beneficiaryCurrency: type: string nullable: true quoteTimestamp: type: string format: date-time expiryTimestamp: type: string format: date-time expiry: type: integer format: int32 expiryRemaining: type: integer format: int32 conversionFactors: type: array items: type: object properties: fromCurrency: type: string nullable: true toCurrency: type: string nullable: true rate: type: number format: double additionalProperties: false nullable: true additionalProperties: false '400': description: Bad Request content: application/json: schema: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false '404': description: Not Found content: application/json: schema: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false components: schemas: AddWireResponseModel: type: object properties: MessageStatus: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false wireId: type: string format: uuid wireSequenceId: type: string nullable: true additionalProperties: false AddWireStatusRequestModel: type: object properties: processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string lastChangedBy: type: object properties: userId: type: string nullable: true name: type: string nullable: true additionalProperties: false changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true wireId: type: string format: uuid additionalProperties: false Address: type: object properties: street1: type: string nullable: true street2: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true additionalProperties: false AddressModel: type: object properties: street1: type: string nullable: true street2: type: string nullable: true street3: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true fornAddr: type: string nullable: true additionalProperties: false Amount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false AmountModel: type: object properties: restriction: type: string nullable: true value: type: number format: double nullable: true additionalProperties: false ConversionFactor: type: object properties: fromCurrency: type: string nullable: true toCurrency: type: string nullable: true rate: type: number format: double additionalProperties: false CreateRateQuoteRequest: required: - amount - lockSide - paymentCurrency type: object properties: lockSide: enum: - Settlement - Payment type: string paymentCurrency: maxLength: 3 minLength: 0 pattern: ^[A-Z]*$ type: string amount: maximum: 999999999.99 minimum: 0.01 type: number format: double settlementCurrency: pattern: ^[USD]+$ type: string nullable: true additionalProperties: false MessageStatusDetailModel: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false MessageStatusLogModel: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false MessageStatusModel: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false Name: type: object properties: common: type: string nullable: true additionalProperties: false PaymentConfirmation: type: object properties: swiftConfirmationId: type: string nullable: true confirmationDate: type: string format: date-time transactionReferenceNumber: type: string nullable: true additionalProperties: false QuoteResponse: type: object properties: quoteId: type: string nullable: true originatorSends: type: number format: double beneficiaryReceives: type: number format: double originatorCurrency: type: string nullable: true beneficiaryCurrency: type: string nullable: true quoteTimestamp: type: string format: date-time expiryTimestamp: type: string format: date-time expiry: type: integer format: int32 expiryRemaining: type: integer format: int32 conversionFactors: type: array items: type: object properties: fromCurrency: type: string nullable: true toCurrency: type: string nullable: true rate: type: number format: double additionalProperties: false nullable: true additionalProperties: false Regulation: type: object properties: name: type: string nullable: true value: type: string nullable: true additionalProperties: false SourceStatus: type: object properties: name: type: string nullable: true value: type: string nullable: true lastChangedBy: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false Status: type: object properties: processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false StatusCodeResult: type: object properties: statusCode: type: integer format: int32 additionalProperties: false UserModel: type: object properties: userId: type: string nullable: true name: type: string nullable: true additionalProperties: false WireModel: required: - aliasName - amount - beneficiaryName - beneficiaryType - destinationCountry - fundSource - originatorName - originatorType - paymentPurpose - wireInPersonType type: object properties: fundSource: minLength: 1 type: string wireInPersonType: minLength: 1 type: string noticeTypes: type: array items: type: string nullable: true transactionDescription: type: string nullable: true reference: type: string nullable: true paymentPurpose: minLength: 1 type: string customerName: type: object properties: common: type: string nullable: true additionalProperties: false aliasName: maxLength: 50 minLength: 1 pattern: ^[^<>\x22]*$ type: string accountId: type: string nullable: true accountType: type: string nullable: true branchCode: type: string nullable: true generalLedgerCostCenter: type: string nullable: true generalLedgerProductCode: type: string nullable: true originatorType: minLength: 1 type: string originatorName: type: object properties: common: type: string nullable: true additionalProperties: false remittanceTransferRule: type: string nullable: true originatorReference: type: string nullable: true originatorIdType: type: string nullable: true originatorId: type: string nullable: true taxId: type: string nullable: true originatorAddress: type: object properties: street1: type: string nullable: true street2: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true additionalProperties: false amount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false sourceType: type: string nullable: true sourceId: type: string nullable: true internetFinancialInstitutionId: type: string nullable: true companyId: type: string nullable: true companyEmployeeId: type: string nullable: true companyEmployeeName: type: string nullable: true companyVerificationId: type: string nullable: true customerId: type: string nullable: true originatorFinancialInstitutionId: type: string nullable: true originatorFinancialInstitutionName: type: string nullable: true originatorAmount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false beneficiaryAmount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false beneficiaryAddress: type: object properties: street1: type: string nullable: true street2: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true additionalProperties: false currencyExchangeRate: type: string nullable: true orderId: type: string nullable: true alternateAccountId: type: string nullable: true alternateAccountType: type: string nullable: true alternateCustomerName: type: object properties: common: type: string nullable: true additionalProperties: false feeType: type: string nullable: true fee: type: number format: double nullable: true accountAnalysisTransactionCode: type: string nullable: true officerCode: type: string nullable: true beneficiaryName: type: object properties: common: type: string nullable: true additionalProperties: false templateId: type: string nullable: true beneficiaryOFACStatusState: type: string nullable: true type: type: string nullable: true businessCategory: type: string nullable: true contactPhoneNumber: type: string nullable: true countryCallingCode: type: string nullable: true paymentNotificationEmailAddresses: type: array items: type: string nullable: true paymentTracker: type: string nullable: true beneficiaryId: type: string nullable: true beneficiaryFinancialInstitutionRoutingId: type: string nullable: true beneficiaryFinancialInstitutionId: type: string nullable: true beneficiaryFinancialInstitutionName: type: string nullable: true paymentMethod: type: string nullable: true receiveFinancialInstitutionBICCode: type: string nullable: true destinationCountry: minLength: 1 type: string beneficiaryFinancialInstitutionAddress: type: object properties: street1: type: string nullable: true street2: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true additionalProperties: false regulations: type: array items: type: object properties: name: type: string nullable: true value: type: string nullable: true additionalProperties: false nullable: true notes: type: array items: type: string nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false nullable: true sourceStatuses: type: array items: type: object properties: name: type: string nullable: true value: type: string nullable: true lastChangedBy: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false nullable: true beneficiaryType: minLength: 1 type: string feeExchangeRate: type: number format: double nullable: true feeExchangeAmount: type: number format: double nullable: true additionalProperties: false WireResponseModel: type: object properties: messageStatus: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false fundSource: type: string nullable: true wireInPersonType: type: string nullable: true noticeTypes: type: array items: type: string nullable: true transactionDescription: type: string nullable: true reference: type: string nullable: true paymentPurpose: type: string nullable: true customerName: type: object properties: common: type: string nullable: true additionalProperties: false aliasName: type: string nullable: true accountId: type: string nullable: true accountType: type: string nullable: true branchCode: type: string nullable: true generalLedgerCostCenter: type: string nullable: true generalLedgerProductCode: type: string nullable: true originatorName: type: object properties: common: type: string nullable: true additionalProperties: false remittanceTransferRule: type: string nullable: true originatorReference: type: string nullable: true originatorIdType: type: string nullable: true originatorId: type: string nullable: true taxId: type: string nullable: true originatorAddress: type: object properties: street1: type: string nullable: true street2: type: string nullable: true street3: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true fornAddr: type: string nullable: true additionalProperties: false amount: type: object properties: restriction: type: string nullable: true value: type: number format: double nullable: true additionalProperties: false sourceType: type: string nullable: true sourceId: type: string nullable: true internetFinancialInstitutionId: type: string nullable: true companyId: type: string nullable: true companyEmployeeId: type: string nullable: true companyEmployeeName: type: string nullable: true companyVerificationId: type: string nullable: true customerId: type: string nullable: true originatorFinancialInstitutionId: type: string nullable: true originatorFinancialInstitutionName: type: string nullable: true originatorAmount: type: object properties: restriction: type: string nullable: true value: type: number format: double nullable: true additionalProperties: false beneficiaryAmount: type: object properties: restriction: type: string nullable: true value: type: number format: double nullable: true additionalProperties: false currencyExchangeRate: type: string nullable: true orderId: type: string nullable: true alternateAccountId: type: string nullable: true alternateAccountType: type: string nullable: true alternateCustomerName: type: object properties: common: type: string nullable: true additionalProperties: false feeType: type: string nullable: true fee: type: number format: double nullable: true accountAnalysisTransactionCode: type: string nullable: true officerCode: type: string nullable: true beneficiaryName: type: object properties: common: type: string nullable: true additionalProperties: false templateId: type: string nullable: true beneficiaryOFACStatusState: type: string nullable: true type: type: string nullable: true businessCategory: type: string nullable: true contactPhoneNumber: type: string nullable: true paymentNotificationEmailAddresses: type: array items: type: string nullable: true paymentTracker: type: string nullable: true beneficiaryId: type: string nullable: true beneficiaryFinancialInstitutionRoutingId: type: string nullable: true beneficiaryFinancialInstitutionId: type: string nullable: true beneficiaryFinancialInstitutionName: type: string nullable: true paymentMethod: type: string nullable: true receiveFinancialInstitutionBICCode: type: string nullable: true destinationCountry: type: string nullable: true beneficiaryFinancialAddress: type: object properties: street1: type: string nullable: true street2: type: string nullable: true street3: type: string nullable: true city: type: string nullable: true stateProvince: type: string nullable: true countryType: type: string nullable: true postalCode: type: string nullable: true fornAddr: type: string nullable: true additionalProperties: false countryCallingCode: type: string nullable: true originatorType: type: string nullable: true beneficiaryType: type: string nullable: true wireSequenceId: type: string nullable: true regulations: type: array items: type: object properties: name: type: string nullable: true value: type: string nullable: true additionalProperties: false nullable: true notes: type: array items: type: string nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false nullable: true sourceStatuses: type: array items: type: object properties: name: type: string nullable: true value: type: string nullable: true lastChangedBy: type: string nullable: true timeDate: type: string format: date-time comment: type: string nullable: true additionalProperties: false nullable: true beneficiaryStatus: type: string nullable: true amountMemoPosts: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true feeActualPosts: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true exchangeFeeActualPosts: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true amountActualPosts: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true glSettlementPost: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true glProviderPost: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true bookOrderInfo: type: array items: type: object properties: paymentInstructionId: type: integer format: int32 availableDate: type: string format: date-time additionalProperties: false nullable: true accountAnalysisPost: type: array items: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false nullable: true createdBy: type: string nullable: true updatedBy: type: string nullable: true feeExchangeRate: type: number format: double nullable: true feeExchangeAmount: type: number format: double nullable: true orderNumber: type: string nullable: true bookDealTime: type: string format: date-time nullable: true cancellationCharges: type: array items: type: object properties: amount: type: number format: double currency: type: string nullable: true additionalProperties: false nullable: true canceledOrderNumber: type: string nullable: true paymentConfirmation: type: object properties: swiftConfirmationId: type: string nullable: true confirmationDate: type: string format: date-time transactionReferenceNumber: type: string nullable: true additionalProperties: false additionalProperties: false ReceiptModel: type: object properties: sequenceNumber: type: integer format: int64 nullable: true receiptId: type: string nullable: true batchNumber: type: integer format: int32 amount: type: number format: double additionalProperties: false BookOrderInfo: type: object properties: paymentInstructionId: type: integer format: int32 availableDate: type: string format: date-time additionalProperties: false CancellationCharge: type: object properties: amount: type: number format: double currency: type: string nullable: true additionalProperties: false WireTransferSearchRequestBaseModel: type: object properties: createStartDate: type: string format: date-time nullable: true createEndDate: type: string format: date-time nullable: true lowAmount: maximum: 999999999.99 minimum: 0 type: number format: double nullable: true highAmount: maximum: 999999999.99 minimum: 0 type: number format: double nullable: true accountId: maxLength: 100 type: string nullable: true statuses: type: array items: type: object properties: processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string lastChangedBy: type: string nullable: true changeApprovalUser: type: string nullable: true changeIPAddress: type: string nullable: true timeDate: type: string format: date-time additionalProperties: false nullable: true sourceTypes: type: array items: type: string nullable: true accountType: enum: - Deposit - Savings - ChristmasClub - Loan - Overdraft - GeneralLedger type: string nullable: true destinationCountry: maxLength: 2 minLength: 0 type: string nullable: true currencyType: maxLength: 3 minLength: 0 type: string nullable: true institutionId: maxLength: 100 type: string nullable: true wireSequenceId: maxLength: 100 type: string nullable: true wireId: maxLength: 100 type: string nullable: true beneficiaryFinancialInstitutionId: maxLength: 100 type: string nullable: true beneficiaryName: type: object properties: common: type: string nullable: true additionalProperties: false originatorName: type: object properties: common: type: string nullable: true additionalProperties: false originatorReference: maxLength: 200 type: string nullable: true beneficiaryFinancialInstitutionName: maxLength: 200 type: string nullable: true companyId: maxLength: 100 type: string nullable: true internetFinancialInstitutionId: maxLength: 100 type: string nullable: true transactionDescription: maxLength: 500 type: string nullable: true branchCode: maxLength: 100 type: string nullable: true generalLedgerCostCenter: maxLength: 100 type: string nullable: true generalLedgerProductCode: maxLength: 100 type: string nullable: true remittanceTransferRule: enum: - 'True' - 'False' type: string nullable: true additionalProperties: false WireTransferSearchResponseEAModel: type: object properties: messageStatus: type: object properties: responseCode: type: string nullable: true description: type: string nullable: true messageSource: type: string nullable: true details: type: array items: required: - category - code - description type: object properties: code: minLength: 1 type: string category: enum: - Error - Fault - Warning - Overridden - Information type: string description: minLength: 1 type: string element: type: string nullable: true elementValue: type: string nullable: true location: type: string nullable: true additionalProperties: false nullable: true logs: type: array items: type: object properties: store: enum: - Local - EL type: string key: type: string nullable: true additionalProperties: false nullable: true additionalProperties: false paging: type: object properties: nextOffset: type: integer format: int32 results: type: integer format: int32 total: type: integer format: int64 additionalProperties: false wires: type: array items: type: object properties: createDate: type: string format: date-time readOnly: true createdBy: type: string nullable: true accountType: type: string nullable: true accountId: type: string nullable: true beneficiaryName: type: object properties: common: type: string nullable: true additionalProperties: false beneficiaryFinancialInstitutionId: type: string nullable: true branchCode: type: string nullable: true customerId: type: string nullable: true companyId: type: string nullable: true currencyType: type: string nullable: true destinationCountry: type: string nullable: true generalLedgerCostCenter: type: string nullable: true generalLedgerProductCode: type: string nullable: true internetFinancialInstitutionId: type: string nullable: true lastChangedTimeDate: type: string format: date-time updatedBy: type: string nullable: true originatorName: type: object properties: common: type: string nullable: true additionalProperties: false originatorReference: type: string nullable: true remittanceTransferRule: enum: - 'True' - 'False' type: string receiveFinancialInstitutionRoutingId: type: string nullable: true receiveFinancialInstitutionName: type: string nullable: true sourceType: enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - CompanyFinancialInstitutionClerk type: string nullable: true status: enum: - Draft - Cancel - Completed - Error - Pending type: string nullable: true readOnly: true transactionDescription: type: string nullable: true wireId: type: string nullable: true wireSequenceId: type: string nullable: true isSendAllowed: type: boolean processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string amount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false additionalProperties: false nullable: true additionalProperties: false PagingModel: type: object properties: nextOffset: type: integer format: int32 results: type: integer format: int32 total: type: integer format: int64 additionalProperties: false WireTransferSearchResponseEAItem: type: object properties: createDate: type: string format: date-time readOnly: true createdBy: type: string nullable: true accountType: type: string nullable: true accountId: type: string nullable: true beneficiaryName: type: object properties: common: type: string nullable: true additionalProperties: false beneficiaryFinancialInstitutionId: type: string nullable: true branchCode: type: string nullable: true customerId: type: string nullable: true companyId: type: string nullable: true currencyType: type: string nullable: true destinationCountry: type: string nullable: true generalLedgerCostCenter: type: string nullable: true generalLedgerProductCode: type: string nullable: true internetFinancialInstitutionId: type: string nullable: true lastChangedTimeDate: type: string format: date-time updatedBy: type: string nullable: true originatorName: type: object properties: common: type: string nullable: true additionalProperties: false originatorReference: type: string nullable: true remittanceTransferRule: enum: - 'True' - 'False' type: string receiveFinancialInstitutionRoutingId: type: string nullable: true receiveFinancialInstitutionName: type: string nullable: true sourceType: enum: - FinancialInstitution - Internet - DirectLine - TreasuryManagement - ThirdParty - CompanyFinancialInstitutionClerk type: string nullable: true status: enum: - Draft - Cancel - Completed - Error - Pending type: string nullable: true readOnly: true transactionDescription: type: string nullable: true wireId: type: string nullable: true wireSequenceId: type: string nullable: true isSendAllowed: type: boolean processStep: enum: - New - OFAC - DualControl - FirstTransfer - Send - Process type: string state: enum: - Error - Ready - QuoteExpired - QuoteRequired - Passed - Suspect - NotSuspect - Incomplete - NextDay - Pending - Required - NotRequired - ContactCustomer - Rejected - Canceled - NSF - Initiated - AutoInitiated - Complete - Acknowledged - Failed - Return - NextDayReturn type: string amount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false additionalProperties: false EAAmount: type: object properties: value: type: number format: double currencyType: type: string nullable: true additionalProperties: false securitySchemes: Bearer: type: apiKey description: >- JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}" name: Authorization in: header OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: >- https://jxdmz.jackhenry.com/jxchange/identity/authserver/connect/token scopes: {} x-jh: publishing: type: Integration stage: prod isPublic: true group: Origin-Wires name: Jack Henry International Wires security: - OAuth2: []