{ "openapi" : "3.0.2", "info" : { "title" : "Case Manager - Claim Non Receipt", "description" : "The Creditor Claim Non-Receipt process applies when an investigation for missing funds must be initiated i.e., a creditor claims that a payment has not been received. The underlying payment can be either already received by the creditor agent or not yet received by the creditor agent. \n\nThe initiator of the Creditor Claim Non-Receipt (the requestor) can be any agent but will usually the debtor agent. The responder will always be the “owner” of the payment (it could be the creditor agent or an intermediary agent). This can be either on the Swift network or outside the Swift network. \n\n“Creditor Claim Non-Receipt” has been widely known as “Beneficiary Claim Non Receipt” (BCNR) historically. Creditor Agent Claim Cover Non-Receipt (CONR) follows the same logic and principles when the underlying payment relates to a cover flow. CCNR and CONR result in similar response types (and therefore associated data elements). \n\nThis API allows the requestor to initiate an investigation, the responder to respond to the investigation and both to get data related to the investigation.\n\n***Release Note explaining difference between version 7.0.5 and original version 7.0.4***\n\nIn version 7.0.5, there was a correction in the server urls adding the Sandbox server details and changing the base path from Case Manager to Case Management.\n", "contact" : { "name" : "Developer Hub", "url" : "https://developer.swift.com", "email" : "developer-support@swift.com" }, "license" : { "name" : "API Restricted License", "url" : "https://developer.swift.com/api-license" }, "version" : "7.0.5" }, "servers" : [ { "description" : "Test", "url" : "https://api-test.swiftnet.sipn.swift.com/swift-casemanagement-ClaimNonReceipt-pilot/v7" }, { "description" : "Production", "url" : "https://api.swiftnet.sipn.swift.com/swift-casemanagement-ClaimNonReceipt/v7" }, { "description" : "Sandbox", "url" : "https://sandbox.swift.com/swift-casemanagement-ClaimNonReceipt/v7" } ], "paths" : { "/claim-nonreceipt-investigations-requests" : { "post" : { "tags" : [ "create claim non receipt investigation request" ], "summary" : "Create claim non receipt investigation request.", "description" : "This API is used by the requestor to create a claim non receipt investigation request.", "operationId" : "claimNonReceiptInvestigationRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClaimNonReceiptInvestigationRequest2" }, "examples" : { "claim_non_receipt_investigation_request" : { "$ref" : "#/components/examples/claim_non_receipt_investigation_request" } } } } }, "responses" : { "200" : { "description" : "This is the output received by the requestor creating a claim non receipt investigation request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationRequestOutput1" }, "examples" : { "claim_non_receipt_investigation_request_output" : { "$ref" : "#/components/examples/claim_non_receipt_investigation_request_output" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServerUnavailable" }, "504" : { "$ref" : "#/components/responses/504-GatewayTimeout" }, "default" : { "$ref" : "#/components/responses/500-InternalServerError" } } } }, "/claim-nonreceipt-investigations-responses" : { "post" : { "tags" : [ "create claim non receipt investigation response" ], "summary" : "Create claim non receipt investigation response.", "description" : "This API is used by the responder to create a claim non receipt investigation response.", "operationId" : "claimNonReceiptInvestigationResponse", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClaimNonReceiptInvestigationResponse2" }, "examples" : { "claim_non_receipt_investigation_response" : { "$ref" : "#/components/examples/claim_non_receipt_investigation_response" } } } } }, "responses" : { "200" : { "description" : "ClaimNonReceiptInvestigationResponse", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationResponseOutput1" }, "examples" : { "claim_non_receipt_investigation_response_output" : { "$ref" : "#/components/examples/claim_non_receipt_investigation_response_output" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServerUnavailable" }, "504" : { "$ref" : "#/components/responses/504-GatewayTimeout" }, "default" : { "$ref" : "#/components/responses/500-InternalServerError" } } } }, "/claim-nonreceipt-investigations" : { "get" : { "tags" : [ "get claim non receipt investigation data" ], "summary" : "Get claim non receipt investigation data.", "description" : "This API is used to get claim non receipt investigation data.", "operationId" : "getClaimNonReceiptInvestigationData", "parameters" : [ { "$ref" : "#/components/parameters/uetr" }, { "$ref" : "#/components/parameters/eir" }, { "$ref" : "#/components/parameters/eir_status" }, { "$ref" : "#/components/parameters/from_date_time" }, { "$ref" : "#/components/parameters/to_date_time" }, { "$ref" : "#/components/parameters/maximum_number" }, { "$ref" : "#/components/parameters/next" } ], "responses" : { "200" : { "description" : "ClaimNonReceiptInvestigationDataResponse", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClaimNonReceiptInvestigationDataResponse3" }, "examples" : { "claim_non_receipt_investigation_data" : { "$ref" : "#/components/examples/claim_non_receipt_investigation_data" } } } } }, "204" : { "description" : "No Content" }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServerUnavailable" }, "504" : { "$ref" : "#/components/responses/504-GatewayTimeout" }, "default" : { "$ref" : "#/components/responses/500-InternalServerError" } } } } }, "components" : { "schemas" : { "AccountIdentification59Choice" : { "type" : "object", "description" : "Specifies the unique identification of an account as assigned by the account servicer.", "additionalProperties" : true, "oneOf" : [ { "type" : "object", "additionalProperties" : false, "properties" : { "iban" : { "$ref" : "#/components/schemas/IBAN2007Identifier" } }, "required" : [ "iban" ] }, { "type" : "object", "additionalProperties" : false, "properties" : { "other_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax34Text" } }, "required" : [ "other_identification" ] } ] }, "ActiveCurrencyCode" : { "type" : "string", "pattern" : "^[A-Z]{3,3}$", "description" : "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"." }, "ActiveOrHistoricCurrencyCode" : { "type" : "string", "pattern" : "^[A-Z]{3,3}$", "description" : "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"." }, "BICFIDec2014Identifier" : { "type" : "string", "description" : "Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".", "pattern" : "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$" }, "BaseOneRate" : { "type" : "string", "description" : "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.", "maxLength" : 12 }, "BookingConfirmation4" : { "type" : "object", "description" : "Specifies the booking details for the underlying transaction or entry.", "additionalProperties" : false, "properties" : { "amount" : { "$ref" : "#/components/schemas/CASE_Amount" }, "credit_debit_indicator" : { "$ref" : "#/components/schemas/CreditDebit1Code" }, "exchange_rate" : { "$ref" : "#/components/schemas/BaseOneRate" }, "account" : { "$ref" : "#/components/schemas/CashAccount210" }, "booking_date" : { "$ref" : "#/components/schemas/ISODate" }, "value_date" : { "$ref" : "#/components/schemas/ISODate" }, "references" : { "$ref" : "#/components/schemas/TransactionReferences9" }, "reason" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax140Text" } }, "required" : [ "amount", "credit_debit_indicator", "account", "value_date", "references" ] }, "CASE_Amount" : { "type" : "object", "description" : "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.", "additionalProperties" : false, "properties" : { "currency" : { "$ref" : "#/components/schemas/ActiveCurrencyCode" }, "amount" : { "type" : "string", "maxLength" : 15, "pattern" : "^0*(([0-9]{0,9}\\.[0-9]{1,5})|([0-9]{0,10}\\.[0-9]{1,4})|([0-9]{0,11}\\.[0-9]{1,3})|([0-9]{0,12}\\.[0-9]{1,2})|([0-9]{0,13}\\.[0-9]{1,1})|([0-9]{0,18}\\.)|0*|([0-9]{0,14}))$" } }, "required" : [ "currency", "amount" ] }, "CASE_DateTime" : { "type" : "string", "description" : "A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm). \r\n\r\nThis representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\r\nNote on the time format:\r\n1) beginning / end of calendar day\r\n00:00:00 = the beginning of a calendar day\r\n24:00:00 = the end of a calendar day\r\n2) fractions of second in time format\r\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.\r\n\r\nExample: 2020-07-16T19:20:30.45+01:00", "pattern" : "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.[0-9]+)?(?:Z|[+-][01]\\d:[0-5]\\d)?$" }, "CASE_RestrictedFINXMax105Text" : { "type" : "string", "description" : "Specifies a character string with a minimum length of 1, and a maximum length of 105 characters, and limited to character set X, that is, 0-9 a-z A-Z / - ? : ( ) . , ' + .", "minLength" : 1, "maxLength" : 105, "pattern" : "^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ ]+$" }, "CASE_RestrictedFINXMax140Text" : { "type" : "string", "description" : "Specifies a character string with a minimum length of 1, and a maximum length of 140 characters, and limited to character set X, that is, 0-9 a-z A-Z / - ? : ( ) . , ' + .", "minLength" : 1, "maxLength" : 140, "pattern" : "^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ ]+$" }, "CASE_RestrictedFINXMax320Text_Extended" : { "type" : "string", "description" : "Specifies a character string with a minimum length of 1, and a maximum length of 320 characters, and limited to character set X, that is, 0-9 a-z A-Z / - ? : ( ) . , ' + . that is extended to support the following additional characters !#$%&*=^_`{|}~\";<>@[\\]", "minLength" : 1, "maxLength" : 320, "pattern" : "^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ !#$%&\\*=^_`\\{\\|\\}~\";<>@\\[\\\\\\]]+$" }, "CASE_RestrictedFINXMax34Text" : { "type" : "string", "description" : "Specifies a character string with a minimum length of 1, and a maximum length of 34 characters, and limited to character set X, that is, 0-9 a-z A-Z / - ? : ( ) . , ' + . and disable the use of slash \"/\" at the beginning and end of line and double slash \"//\" within the line.", "minLength" : 1, "maxLength" : 34, "pattern" : "^([0-9a-zA-Z\\-\\?:\\(\\)\\.,'\\+ ]([0-9a-zA-Z\\-\\?:\\(\\)\\.,'\\+ ]*(/[0-9a-zA-Z\\-\\?:\\(\\)\\.,'\\+ ])?)*)$" }, "CASE_RestrictedFINXMax35Text" : { "type" : "string", "description" : "Specifies a character string with a minimum length of 1, and a maximum length of 35 characters, and limited to character set X, that is, 0-9 a-z A-Z / - ? : ( ) . , ‘ + .", "minLength" : 1, "maxLength" : 35, "pattern" : "^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ ]+$" }, "CashAccount210" : { "type" : "object", "description" : "Provides the details to identify an account.", "additionalProperties" : false, "properties" : { "identification" : { "$ref" : "#/components/schemas/AccountIdentification59Choice" }, "currency" : { "$ref" : "#/components/schemas/ActiveOrHistoricCurrencyCode" }, "proxy" : { "$ref" : "#/components/schemas/ProxyAccountIdentification4" } } }, "ClaimNonReceiptInvestigationDataResponse3" : { "type" : "object", "description" : "ClaimNonReceiptInvestigationDataResponse", "additionalProperties" : false, "properties" : { "investigations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EIRData7" } }, "next" : { "$ref" : "#/components/schemas/Max350Text" } }, "required" : [ "investigations" ] }, "ClaimNonReceiptInvestigationRequest2" : { "type" : "object", "description" : "Contains the elements to create a claim non receipt investigation request.", "additionalProperties" : false, "properties" : { "from" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "investigation_type" : { "$ref" : "#/components/schemas/InvestigationType1Code" }, "underlying_instrument" : { "$ref" : "#/components/schemas/ExternalInvestigationInstrument1Code" }, "underlying" : { "$ref" : "#/components/schemas/UnderlyingData1" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "request_originator" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "service_level" : { "$ref" : "#/components/schemas/ExternalInvestigationServiceLevel1Code" }, "investigation_reason" : { "$ref" : "#/components/schemas/InvestigationType1Code" } }, "required" : [ "from", "message_identification", "requestor_investigation_identification", "investigation_type", "underlying_instrument", "underlying", "requestor", "responder" ] }, "ClaimNonReceiptInvestigationResponse2" : { "type" : "object", "description" : "ClaimNonReceiptInvestigationResponse", "additionalProperties" : false, "properties" : { "from" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "investigation_status" : { "$ref" : "#/components/schemas/ExternalInvestigationStatus1Code" }, "investigation_status_reason" : { "$ref" : "#/components/schemas/InvestigationStatusReason2Choice" }, "original_investigation_reason" : { "$ref" : "#/components/schemas/InvestigationType1Code" }, "response_data" : { "$ref" : "#/components/schemas/InvestigationDataRecord6Choice" }, "response_originator" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "original_investigation_request" : { "$ref" : "#/components/schemas/InvestigationRequest15" } }, "required" : [ "from", "message_identification", "investigation_status", "original_investigation_request" ] }, "CreditDebit1Code" : { "type" : "string", "description" : "Specifies if an operation is an increase or a decrease.\n*`CRDT`-Operation is an increase.", "enum" : [ "CRDT" ] }, "EIRData7" : { "type" : "object", "description" : "Contains all data related to an EIR.\r\nUsage: Groups all investigation exchanges per EIR.", "additionalProperties" : false, "properties" : { "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "eir_status" : { "$ref" : "#/components/schemas/Max4Text" }, "related_investigation_type" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Max4Text" } }, "eir_last_update_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "eir_initiation_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "tracker_transaction" : { "$ref" : "#/components/schemas/TrackerTransaction1" }, "investigation_exchange" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationExchange7" } } }, "required" : [ "eir", "eir_status", "eir_last_update_date_time", "eir_initiation_date_time", "investigation_exchange" ] }, "ErrorMessage" : { "type" : "object", "required" : [ "code", "severity", "text" ], "properties" : { "severity" : { "type" : "string", "enum" : [ "Fatal", "Transient", "Logic" ] }, "code" : { "type" : "string" }, "text" : { "type" : "string" }, "user_message" : { "type" : "string" }, "more_info" : { "type" : "string", "format" : "uri" } } }, "ExternalInvestigationAction1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the requested action, as published in an external investigation action code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "ExternalInvestigationActionReason1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the requested action, as published in an external investigation action code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "ExternalInvestigationInstrument1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the type of instrument or product to which the investigation refers, as published in an external investigation instrument code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "ExternalInvestigationServiceLevel1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the investigation service level, as published in an external investigation service level code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "ExternalInvestigationStatus1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the investigation status, as published in an external investigation status code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "ExternalInvestigationStatusReason1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the reason for the investigation status, as published in an external investigation status reason code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "ExternalProxyAccountType1Code" : { "type" : "string", "minLength" : 1, "maxLength" : 4, "description" : "Specifies the external proxy account type code, as published in the proxy account type external code set.\r\nExternal code sets can be downloaded from www.iso20022.org." }, "IBAN2007Identifier" : { "type" : "string", "description" : "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services - International Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.", "pattern" : "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, "ISODate" : { "type" : "string", "description" : "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "pattern" : "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\\d:[0-5]\\d)?$" }, "ISONormalisedDateTime" : { "type" : "string", "description" : "an ISODateTime whereby all timezoned dateTime values are UTC.", "pattern" : "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.[0-9]+)?(?:Z)$" }, "InvestigationActionReason3" : { "type" : "object", "description" : "Provides information on the action reason.", "additionalProperties" : false, "properties" : { "reason" : { "$ref" : "#/components/schemas/ExternalInvestigationActionReason1Code" }, "additional_information" : { "type" : "array", "maxItems" : 2, "items" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax105Text" } } }, "required" : [ "reason" ] }, "InvestigationDataRecord6Choice" : { "type" : "object", "additionalProperties" : true, "oneOf" : [ { "type" : "object", "additionalProperties" : false, "properties" : { "confirmation" : { "$ref" : "#/components/schemas/BookingConfirmation4" } }, "required" : [ "confirmation" ] }, { "type" : "object", "additionalProperties" : false, "properties" : { "transaction_status" : { "$ref" : "#/components/schemas/PaymentTransactionstatus3" } }, "required" : [ "transaction_status" ] } ] }, "InvestigationExchange7" : { "type" : "object", "description" : "Details of an investigation exchange.", "additionalProperties" : false, "properties" : { "investigation_exchange_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "investigation_exchange_status" : { "$ref" : "#/components/schemas/Max4Text" }, "investigation_exchange_status_reason" : { "$ref" : "#/components/schemas/Max4Text" }, "investigation_request_data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationRequest16" } }, "investigation_response_data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationResponse12" } }, "investigation_tracking_data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationTrackingData1" } } }, "required" : [ "investigation_exchange_identification", "investigation_exchange_status", "investigation_request_data" ] }, "InvestigationIdentification2" : { "type" : "object", "description" : "Provides further means of referencing an investigation request.", "additionalProperties" : false, "properties" : { "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" } }, "required" : [ "eir" ] }, "InvestigationRequest15" : { "type" : "object", "description" : "Specifies the details of an investigation request, including identification and type.", "additionalProperties" : false, "properties" : { "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "request_action" : { "$ref" : "#/components/schemas/ExternalInvestigationAction1Code" }, "request_action_reason" : { "$ref" : "#/components/schemas/InvestigationActionReason3" }, "investigation_type" : { "$ref" : "#/components/schemas/InvestigationType1Code" }, "underlying_instrument" : { "$ref" : "#/components/schemas/ExternalInvestigationInstrument1Code" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" } }, "required" : [ "message_identification", "requestor_investigation_identification", "eir", "investigation_type", "underlying_instrument", "requestor", "responder" ] }, "InvestigationRequest16" : { "type" : "object", "description" : "Specifies the details of an investigation request.", "additionalProperties" : false, "properties" : { "network_reference" : { "$ref" : "#/components/schemas/Max50Text" }, "message_name_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "from" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "to" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "received_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "event_creation_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "duplicate_message_reference" : { "$ref" : "#/components/schemas/Max50Text" }, "valid" : { "$ref" : "#/components/schemas/TrueFalseIndicator" }, "invalidity_reason" : { "$ref" : "#/components/schemas/Max4Text" }, "invalidity_description" : { "$ref" : "#/components/schemas/Max350Text" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "request_action" : { "$ref" : "#/components/schemas/ExternalInvestigationAction1Code" }, "request_action_reason" : { "$ref" : "#/components/schemas/InvestigationActionReason3" }, "investigation_type" : { "$ref" : "#/components/schemas/InvestigationType1Code" }, "underlying_instrument" : { "$ref" : "#/components/schemas/ExternalInvestigationInstrument1Code" }, "underlying" : { "$ref" : "#/components/schemas/UnderlyingData1" }, "request_originator" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "service_level" : { "$ref" : "#/components/schemas/ExternalInvestigationServiceLevel1Code" }, "investigation_reason" : { "$ref" : "#/components/schemas/InvestigationType1Code" } }, "required" : [ "message_name_identification", "from", "to", "requestor", "responder", "message_identification", "investigation_type", "underlying_instrument", "underlying" ] }, "InvestigationRequest20" : { "type" : "object", "description" : "Specifies the details of an investigation request, including identification and type.", "additionalProperties" : false, "properties" : { "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "request_action" : { "$ref" : "#/components/schemas/ExternalInvestigationAction1Code" }, "request_action_reason" : { "$ref" : "#/components/schemas/InvestigationActionReason3" }, "investigation_type" : { "$ref" : "#/components/schemas/InvestigationType1Code" }, "underlying_instrument" : { "$ref" : "#/components/schemas/ExternalInvestigationInstrument1Code" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" } }, "required" : [ "message_identification", "eir", "investigation_type", "underlying_instrument", "requestor", "responder" ] }, "InvestigationRequestOutput1" : { "type" : "object", "description" : "InvestigationRequestOutput", "additionalProperties" : false, "properties" : { "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" } }, "required" : [ "eir", "requestor_investigation_identification", "message_identification", "requestor", "responder" ] }, "InvestigationResponse12" : { "type" : "object", "description" : "Provides details of the investigation response.", "additionalProperties" : false, "properties" : { "network_reference" : { "$ref" : "#/components/schemas/Max50Text" }, "message_name_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "from" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "to" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "received_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "event_creation_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "duplicate_message_reference" : { "$ref" : "#/components/schemas/Max50Text" }, "valid" : { "$ref" : "#/components/schemas/TrueFalseIndicator" }, "invalidity_reason" : { "$ref" : "#/components/schemas/Max4Text" }, "invalidity_description" : { "$ref" : "#/components/schemas/Max350Text" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "investigation_status" : { "$ref" : "#/components/schemas/ExternalInvestigationStatus1Code" }, "investigation_status_reason" : { "$ref" : "#/components/schemas/InvestigationStatusReason2Choice" }, "original_investigation_reason" : { "$ref" : "#/components/schemas/InvestigationType1Code" }, "response_data" : { "$ref" : "#/components/schemas/InvestigationDataRecord6Choice" }, "response_originator" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "original_investigation_request" : { "$ref" : "#/components/schemas/InvestigationRequest20" } }, "required" : [ "message_name_identification", "from", "to", "requestor", "responder", "investigation_status", "original_investigation_request" ] }, "InvestigationResponseOutput1" : { "type" : "object", "description" : "InvestigationResponseOutput", "additionalProperties" : false, "properties" : { "eir" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "requestor_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "responder_investigation_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "investigation_status" : { "$ref" : "#/components/schemas/ExternalInvestigationStatus1Code" }, "investigation_status_reason" : { "$ref" : "#/components/schemas/InvestigationStatusReason2Choice" } }, "required" : [ "eir", "requestor_investigation_identification", "original_message_identification", "message_identification", "requestor", "responder", "investigation_status" ] }, "InvestigationStatusReason2Choice" : { "type" : "object", "description" : "Specifies the reason for the investigation status.", "additionalProperties" : true, "oneOf" : [ { "type" : "object", "additionalProperties" : false, "properties" : { "code" : { "$ref" : "#/components/schemas/ExternalInvestigationStatusReason1Code" } }, "required" : [ "code" ] }, { "type" : "object", "additionalProperties" : false, "properties" : { "proprietary" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" } }, "required" : [ "proprietary" ] } ] }, "InvestigationTrackingData1" : { "type" : "object", "description" : "Tracking details in relation to an investigation.", "additionalProperties" : false, "properties" : { "network_reference" : { "$ref" : "#/components/schemas/Max50Text" }, "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "message_name_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "from" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "to" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "event_creation_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" }, "investigation_tracking_status" : { "$ref" : "#/components/schemas/Max4Text" }, "investigation_tracking_status_reason" : { "$ref" : "#/components/schemas/Max4Text" }, "requestor" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "responder" : { "$ref" : "#/components/schemas/BICFIDec2014Identifier" }, "tracked_message_identification" : { "$ref" : "#/components/schemas/TrackedMessageIdentification1" }, "investigation_identification" : { "$ref" : "#/components/schemas/InvestigationIdentification2" } }, "required" : [ "network_reference", "message_identification", "message_name_identification", "from", "to", "event_creation_date_time", "investigation_tracking_status", "requestor", "responder", "tracked_message_identification", "investigation_identification" ] }, "InvestigationType1Code" : { "type" : "string", "description" : "Type of claim non receipt investigation.\n*`CONR`-Identifies that the investigation is a creditor agent claim cover non receipt.\n*`CCNR`-Identifies that investigation is a creditor claim non receipt.", "enum" : [ "CONR", "CCNR" ] }, "Max350Text" : { "type" : "string", "description" : "Specifies a character string with a maximum length of 350 characters.", "minLength" : 1, "maxLength" : 350 }, "Max35Text" : { "type" : "string", "description" : "Specifies a character string with a maximum length of 35 characters.", "minLength" : 1, "maxLength" : 35 }, "Max4Text" : { "type" : "string", "description" : "Specifies a character string with a maximum length of 4 characters.", "minLength" : 1, "maxLength" : 4 }, "Max50Text" : { "type" : "string", "description" : "Specifies a character string with a maximum length of 50 characters.", "minLength" : 1, "maxLength" : 50 }, "PaymentTransactionstatus3" : { "type" : "object", "description" : "Specifies the status of a payment transaction.", "additionalProperties" : false, "properties" : { "status" : { "$ref" : "#/components/schemas/Max4Text" }, "reason" : { "$ref" : "#/components/schemas/Max4Text" }, "additional_information" : { "type" : "array", "maxItems" : 2, "items" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax105Text" } } }, "required" : [ "status" ] }, "ProprietaryReference2" : { "type" : "object", "description" : "Set of elements to identify a proprietary reference.", "additionalProperties" : false, "properties" : { "type" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "reference" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" } }, "required" : [ "type", "reference" ] }, "ProxyAccountIdentification4" : { "type" : "object", "description" : "Information related to a proxy identification of the account.", "additionalProperties" : false, "properties" : { "type" : { "$ref" : "#/components/schemas/ProxyAccountType3Choice" }, "identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax320Text_Extended" } }, "required" : [ "identification" ] }, "ProxyAccountType3Choice" : { "type" : "object", "description" : "Specifies the scheme used for the identification of an account alias.", "additionalProperties" : true, "oneOf" : [ { "type" : "object", "additionalProperties" : false, "properties" : { "code" : { "$ref" : "#/components/schemas/ExternalProxyAccountType1Code" } }, "required" : [ "code" ] }, { "type" : "object", "additionalProperties" : false, "properties" : { "proprietary" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" } }, "required" : [ "proprietary" ] } ] }, "TrackedMessageIdentification1" : { "type" : "object", "description" : "Provides information on the original investigation request and if applicable on the original investigation response message.", "additionalProperties" : false, "properties" : { "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "message_name_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "creation_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" } }, "required" : [ "message_identification", "message_name_identification", "creation_date_time" ] }, "TrackerPaymentStatusReason3Code" : { "type" : "string", "description" : "Provides reason for reject/return.\n*`AM06`-Below limit.\n*`RC01`-Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode).\n*`AC06`-Account specified is blocked, prohibiting posting of transactions against it.\n*`AM07`-Amount specified in message has been blocked by regulatory authorities.\n*`AC04`-Account number specified has been closed on the bank of account's books.\n*`AC07`-Creditor account number closed.\n*`G004`-Credit to the creditor's account is pending as status Originator is waiting for funds provided via a cover.\n*`DUPL`-Payment is a duplicate of another payment.\n*`ERIN`-The Extended Remittance Information (ERI) option is not supported.\n*`FOCR`-Return following a cancellation request.\n*`FR01`-Returned as a result of fraud.\n*`BE01`-Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency).\n*`AC01`-Account number is invalid or missing\n*`AGNT`-Agent in the payment workflow is incorrect.\n*`CURR`-Currency of the payment is incorrect.\n*`AM04`-Amount of funds available to cover specified message amount is insufficient.\n*`FF06`-Category Purpose code is missing or invalid.\n*`RC08`-Routing code not valid for local clearing.\n*`RC04`-Creditor bank identifier is invalid or missing.\n*`AC02`-Debtor account number invalid or missing\r\n\n*`AC13`-Debtor account type is missing or invalid.\n*`RR11`-Invalid or missing identification of a bank proprietary service.\n*`RC03`-Debtor bank identifier is invalid or missing\n*`RC11`-Intermediary Agent is invalid or missing.\n*`FF05`-Local Instrument code is missing or invalid.\n*`RR12`-Invalid or missing identification required within a particular country or payment type.\n*`FF03`-Payment Type Information is missing or invalid. Generic usage if cannot specify Service Level or Local Instrument code.\n*`FF07`-Purpose is missing or invalid.\n*`FF04`-Service Level code is missing or invalid.\n*`RR09`-Structured creditor reference invalid or missing.\n*`BE04`-Specification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress).\n*`RR03`-Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.\n*`RR01`-Specification of the debtor’s account or unique identification needed for reasons of regulatory requirements is insufficient or missing\n*`BE07`-Specification of debtor's address, which is required for payment, is missing/not correct.\n*`RR02`-Specification of the debtor’s name and/or address needed for regulatory requirements is insufficient or missing.\r\n\n*`NOAS`-Failed to contact beneficiary.\n*`AM02`-Specific transaction/message amount is greater than allowed maximum.\n*`AM03`-Specific message amount is an non processable currency outside of existing agreement.\n*`NOCM`-Customer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements which render an account inactive for certain processing.\n*`MS03`-Reason has not been specified by agent.\n*`MS02`-Reason has not been specified by end customer.\n*`RR05`-Regulatory or Central Bank Reporting information missing, incomplete or invalid.\n*`RR04`-Regulatory Reason \n*`RR07`-Remittance information structure does not comply with rules for payment type.\n*`RR08`-Remittance information truncated to comply with rules for payment type.\n*`CUST`-At request of creditor.\n*`RR06`-Tax information missing, incomplete or invalid.\n*`UPAY`-Payment is not justified.\n*`BE05`-Party who initiated the message is not recognised by the end customer.\n*`AM09`-Amount received is not the amount agreed or expected.\n*`RUTA`-Return following investigation request and no remediation possible.", "enum" : [ "AM06", "RC01", "AC06", "AM07", "AC04", "AC07", "G004", "DUPL", "ERIN", "FOCR", "FR01", "BE01", "AC01", "AGNT", "CURR", "AM04", "FF06", "RC08", "RC04", "AC02", "AC13", "RR11", "RC03", "RC11", "FF05", "RR12", "FF03", "FF07", "FF04", "RR09", "BE04", "RR03", "RR01", "BE07", "RR02", "NOAS", "AM02", "AM03", "NOCM", "MS03", "MS02", "RR05", "RR04", "RR07", "RR08", "CUST", "RR06", "UPAY", "BE05", "AM09", "RUTA" ] }, "TrackerTransaction1" : { "type" : "object", "description" : "Contains the transaction status information.", "additionalProperties" : false, "properties" : { "uetr" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "transaction_status" : { "$ref" : "#/components/schemas/TransactionIndividualStatus5Code" }, "transaction_status_reason" : { "$ref" : "#/components/schemas/TransactionIndividualStatusReason1Code" }, "return_flag" : { "$ref" : "#/components/schemas/TrueFalseIndicator" }, "reject_return_reason" : { "$ref" : "#/components/schemas/TrackerPaymentStatusReason3Code" }, "last_update_date_time" : { "$ref" : "#/components/schemas/ISONormalisedDateTime" } }, "required" : [ "uetr", "transaction_status", "last_update_date_time" ] }, "TransactionIndividualStatus5Code" : { "type" : "string", "description" : "Specifies the status of a single payment transaction.\n*`RJCT`-Payment initiation or individual transaction included in the payment initiation has been rejected.\n*`ACSP`-All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.\n*`ACCC`-Settlement on the creditor's account has been completed. ", "enum" : [ "RJCT", "ACSP", "ACCC" ] }, "TransactionIndividualStatusReason1Code" : { "type" : "string", "description" : "Contains the reason for the status of a payment transaction.\n*`G002`-In a FIToFI Customer Credit Transfer: Credit to the creditor’s account may not be confirmed same day. Update will follow from the Status Originator.\r\nIn a Financial Institution Credit Transfer with cover: Debit/credit to nostro account may not be confirmed same day or Financial Institution Credit Transfer may not be transferred same day. Update will follow from the Status Originator.\n*`G003`-In a FIToFI Customer Credit Transfer: Credit to creditor’s account is pending receipt of required documents. The Status Originator has requested creditor to provide additional documentation. Update will follow from the Status Originator. \r\nIn a Financial Institution Credit Transfer with cover: Status Originator has requested a previous Agent to provide additional information/correct information. Update will follow from the Status Originator.\n*`G004`-In a FIToFI Customer Credit Transfer: Credit to the creditor’s account is pending, status Originator is waiting for funds provided via a cover. Update will follow from the Status Originator.\n*`G006`-Payment has been delivered to creditor agent without service level.\n*`G005`-Payment has been delivered to creditor agent with service level.\n*`G001`-In an FI To FI Customer Credit Transfer: The Status Originator transferred the payment to the next Agent or to a Market Infrastructure. The payment transfer is not tracked. No further updates will follow from the Status Originator.\r\n\r\nIn a Financial Institution Credit Transfer with cover: The Status Originator performed the account booking and transferred the cover transaction to the next Reimbursement Agent or to a Market Infrastructure. The payment transfer is not tracked. No further updates will follow from the Status Originator.\n*`G000`-In an FI To FI Customer Credit Transfer: The Status Originator transferred the payment to the next Agent or to a Market Infrastructure. The payment transfer is tracked. No further updates will follow from the Status Originator.\r\n\r\nIn a Financial Institution Credit Transfer with cover: The Status Originator performed the account booking and transferred the cover transaction to the next Reimbursement Agent or to a Market Infrastructure. The payment transfer is tracked. No further updates will follow from the Status Originator.", "enum" : [ "G002", "G003", "G004", "G006", "G005", "G001", "G000" ] }, "TransactionReferences9" : { "type" : "object", "description" : "Identifies the underlying transaction.", "additionalProperties" : false, "properties" : { "message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "account_servicer_reference" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "instruction_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "end_to_end_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "uetr" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "transaction_identification" : { "$ref" : "#/components/schemas/Max35Text" }, "proprietary" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProprietaryReference2" } } } }, "TrueFalseIndicator" : { "type" : "boolean", "description" : "A flag indicating a True or False value." }, "UUIDv4Identifier" : { "type" : "string", "description" : "Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 \"Universally Unique IDentifier (UUID) URN Namespace\".", "pattern" : "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$" }, "UnderlyingData1" : { "type" : "object", "description" : "Provides details on the subject to which the investigation refers, for example a payment or statement entry.", "additionalProperties" : false, "properties" : { "interbank" : { "$ref" : "#/components/schemas/UnderlyingPaymentTransaction9" } }, "required" : [ "interbank" ] }, "UnderlyingPaymentTransaction9" : { "type" : "object", "description" : "Provides further details on the original payment transaction, to which the investigation message refers.", "additionalProperties" : false, "properties" : { "original_message_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_message_name_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_creation_date_time" : { "$ref" : "#/components/schemas/CASE_DateTime" }, "original_message_delivery_channel" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_instruction_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_end_to_end_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_transaction_identification" : { "$ref" : "#/components/schemas/CASE_RestrictedFINXMax35Text" }, "original_uetr" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "original_interbank_settlement_amount" : { "$ref" : "#/components/schemas/CASE_Amount" }, "original_interbank_settlement_date" : { "$ref" : "#/components/schemas/ISODate" } } } }, "responses" : { "400-BadRequest" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "invalid_request" : { "value" : { "severity" : "Fatal", "code" : "Sw.cm.InvalidRequest", "text" : "Invalid request" } }, "missing_mandatory_field" : { "value" : { "severity" : "Fatal", "code" : "Sw.cm.MandatoryFieldMissing", "text" : "Mandatory field %field missing" } } } } } }, "401-Unauthorized" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "from_authorization_failure" : { "value" : { "severity" : "Fatal", "code" : "Sw.cm.AuthorizationFailure", "text" : "From %From does not have the appropriate RBAC role" } } } } } }, "404-NotFound" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "resource_not_exist" : { "value" : { "severity" : "Fatal", "code" : "SwAP506", "text" : "Resource does not exist." } } } } } }, "429-TooManyRequests" : { "description" : "Too Many Requests", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "system_too_many_requests" : { "value" : { "severity" : "Transient", "code" : "SwAP507", "text" : "Request cannot be processed at this time. Please try later. (header Retry-After indicates how long to wait before making a follow-up request)." } } } } } }, "500-InternalServerError" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "service_internal_error" : { "value" : { "severity" : "Transient", "code" : "Sw.cm.InternalError", "text" : "Internal error" } } } } } }, "503-ServerUnavailable" : { "description" : "ServerUnavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "504-GatewayTimeout" : { "description" : "GatewayTimeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "service_provider_timeout" : { "value" : { "severity" : "Transient", "code" : "SwAP591", "text" : "Service provider timeout" } } } } } }, "default" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "examples" : { "service_internal_error" : { "value" : { "severity" : "Transient", "code" : "Sw.cm.InternalError", "text" : "Internal error" } } } } } } }, "parameters" : { "uetr" : { "in" : "query", "name" : "uetr", "description" : "Identifies the payment transaction, EIRs linked to this uetr will be retrieved", "schema" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "required" : false, "example" : "97ed4827-7b6f-4491-a06f-b548d5a7512d" }, "eir" : { "in" : "query", "name" : "eir", "description" : "Identifies the eir resource, events linked to this eir will be retrieved", "schema" : { "$ref" : "#/components/schemas/UUIDv4Identifier" }, "required" : false, "example" : "97ed4827-7b6f-4491-a06f-b548d5a7512d" }, "eir_status" : { "in" : "query", "name" : "eir_status", "description" : "Identifies the eir status, events for the specific eir status will be retrieved", "schema" : { "$ref" : "#/components/schemas/Max4Text" }, "required" : false, "example" : "OPEN" }, "from_date_time" : { "name" : "from_date_time", "in" : "query", "description" : "Start time window to filter this search, to_date_time can be indicated to limit a window of time.\nPlease note that from_date_time value cannot be older than 124 days from today, if value indicated is older than 124 days, the Tracker will default to the allowed value.\n\nFor test environments the from_date_time value cannot be older than 60 days from today.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" }, "example" : "2024-01-10T00:00:00.000Z" }, "to_date_time" : { "name" : "to_date_time", "in" : "query", "description" : "Stop time window to filter this search, if indicated, from_date_time becomes mandatory. This value indicated should be in the past.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" }, "example" : "2024-04-11T23:59:59.000Z" }, "maximum_number" : { "name" : "maximum_number", "in" : "query", "description" : "Indicates the maximum number of investigations to be returned.\n\nThe maximum value is 100 and the Case Manager defaults to this value if higher or no value is indicated.", "required" : false, "style" : "form", "explode" : true, "schema" : { "minimum" : 1, "maximum" : 100, "type" : "integer", "example" : 50 } }, "next" : { "name" : "next", "in" : "query", "description" : "Indicates a cursor to get the next set of responses. The value of this\nfield should be empty the first request and server may return a value to\nhelp the consumer navigate through the rest of the pages. \n\nWhen passing a next value on a request, all other query parameters should be\nempty.\n\nIf next value is not returned in the response, there are no pages or\nlast page was reached", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/Max350Text" }, "example" : "dXNlIHRoaXMgdmFsdWUgdG8gcmVxdWVzdCBuZXh0IHNldCBvZiBkYXRh" } }, "examples" : { "claim_non_receipt_investigation_request" : { "summary" : "Request sent by requestor to case manager to create a claim non receipt investigation.", "value" : { "from" : "BANKUS33XXX", "message_identification" : "MessageID1", "requestor_investigation_identification" : "ReqInvID1", "investigation_type" : "CCNR", "underlying_instrument" : "XBCT", "underlying" : { "interbank" : { "original_message_identification" : "OrigMessageID1", "original_message_name_identification" : "pacs.008.001.08", "original_creation_date_time" : "2024-01-21T04:48:10.0+01:00", "original_instruction_identification" : "OrigInstrID1", "original_end_to_end_identification" : "OrigE2EID1", "original_uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605", "original_interbank_settlement_amount" : { "currency" : "USD", "amount" : "100000" }, "original_interbank_settlement_date" : "2024-01-21" } }, "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "investigation_reason" : "CCNR" } }, "claim_non_receipt_investigation_request_output" : { "summary" : "Output returned by the case manager to the requestor related to a claim non receipt investigation request.", "value" : { "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "requestor_investigation_identification" : "ReqInvID1", "message_identification" : "MessageID1", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX" } }, "claim_non_receipt_investigation_response" : { "summary" : "Response from the responder to the case manager related to a claim non receipt investigation request.", "value" : { "from" : "BANKFRPPXXX", "message_identification" : "MessageID2", "responder_investigation_identification" : "ResponderInvID1", "investigation_status" : "CLSD", "original_investigation_reason" : "CCNR", "response_data" : { "confirmation" : { "amount" : { "currency" : "USD", "amount" : "100000" }, "credit_debit_indicator" : "CRDT", "account" : { "identification" : { "other_identification" : "Acct123" }, "currency" : "USD" }, "booking_date" : "2024-01-21", "value_date" : "2024-01-21", "references" : { "instruction_identification" : "OrigInstrID1", "end_to_end_identification" : "OrigE2EID1", "uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605" } } }, "original_investigation_request" : { "message_identification" : "OrigMessageID1", "requestor_investigation_identification" : "ReqInvID1", "responder_investigation_identification" : "ResponderInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "investigation_type" : "CCNR", "underlying_instrument" : "XBCT", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX" } } }, "claim_non_receipt_investigation_response_output" : { "summary" : "Output from case manager to a responder in relation to a claim non receipt investigation response.", "value" : { "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "requestor_investigation_identification" : "ReqInvID1", "responder_investigation_identification" : "ResponderInvID1", "original_message_identification" : "OrigMessageID1", "message_identification" : "MessageID2", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "investigation_status" : "CLSD" } }, "claim_non_receipt_investigation_data" : { "summary" : "Response to a get claim non receipt investigations details request.", "value" : { "investigations" : [ { "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "eir_status" : "OPEN", "related_investigation_type" : [ "UTAP" ], "eir_last_update_date_time" : "2024-01-21T16:00:00.000Z", "eir_initiation_date_time" : "2024-01-21T15:00:00.000Z", "tracker_transaction" : { "uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605", "transaction_status" : "ACCC", "return_flag" : false, "last_update_date_time" : "2024-01-21T16:00:00.000Z" }, "investigation_exchange" : [ { "investigation_exchange_identification" : "OrigMessageID1", "investigation_exchange_status" : "CLSD", "investigation_request_data" : [ { "network_reference" : "20240121132213436-010000000016", "message_name_identification" : "InvestigationRequest", "from" : "BANKUS33XXX", "to" : "TRCKCHZZXXX", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "event_creation_date_time" : "2024-01-21T15:00:00.000Z", "valid" : true, "message_identification" : "OrigMessageID1", "requestor_investigation_identification" : "ReqInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "investigation_type" : "CCNR", "underlying_instrument" : "XBCT", "underlying" : { "interbank" : { "original_message_identification" : "OrigMessageID1", "original_message_name_identification" : "pacs.008.001.08", "original_creation_date_time" : "2024-01-21T04:48:10.0", "original_instruction_identification" : "OrigInstrID1", "original_end_to_end_identification" : "OrigE2EID1", "original_uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605", "original_interbank_settlement_amount" : { "currency" : "USD", "amount" : "100000" }, "original_interbank_settlement_date" : "2024-01-21" } }, "investigation_reason" : "CCNR" }, { "network_reference" : "20240121132213436-010000000017", "message_name_identification" : "InvestigationRequest", "from" : "TRCKCHZZXXX", "to" : "BANKFRPPXXX", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "received_date_time" : "2024-01-21T15:00:01.000Z", "event_creation_date_time" : "2024-01-21T15:00:00.000Z", "valid" : true, "message_identification" : "OrigMessageID1", "requestor_investigation_identification" : "ReqInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "investigation_type" : "CCNR", "underlying_instrument" : "XBCT", "underlying" : { "interbank" : { "original_message_identification" : "OrigMessageID1", "original_message_name_identification" : "pacs.008.001.08", "original_creation_date_time" : "2024-01-21T04:48:10.0", "original_instruction_identification" : "OrigInstrID1", "original_end_to_end_identification" : "OrigE2EID1", "original_uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605", "original_interbank_settlement_amount" : { "currency" : "USD", "amount" : "100000" }, "original_interbank_settlement_date" : "2024-01-21" } }, "investigation_reason" : "CCNR" } ], "investigation_response_data" : [ { "network_reference" : "20240121132213436-010000000018", "message_name_identification" : "InvestigationResponse", "from" : "BANKFRPPXXX", "to" : "TRCKCHZZXXX", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "event_creation_date_time" : "2024-01-21T16:00:00.000Z", "valid" : true, "message_identification" : "MessageID2", "responder_investigation_identification" : "ResponderInvID1", "investigation_status" : "CLSD", "original_investigation_reason" : "CCNR", "response_data" : { "confirmation" : { "amount" : { "currency" : "USD", "amount" : "100000" }, "credit_debit_indicator" : "CRDT", "account" : { "identification" : { "other_identification" : "Acct123" }, "currency" : "USD" }, "booking_date" : "2024-01-21", "value_date" : "2024-01-21", "references" : { "instruction_identification" : "OrigInstrID1", "end_to_end_identification" : "OrigE2EID1", "uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605" } } }, "original_investigation_request" : { "message_identification" : "OrigMessageID1", "requestor_investigation_identification" : "ReqInvID1", "responder_investigation_identification" : "ResponderInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "investigation_type" : "CCNR", "underlying_instrument" : "xbct", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX" } }, { "network_reference" : "20240121132213436-010000000019", "message_name_identification" : "InvestigationResponse", "from" : "TRCKCHZZXXX", "to" : "BANKUS33XXX", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "received_date_time" : "2024-01-21T16:00:01.000Z", "event_creation_date_time" : "2024-01-21T16:00:00.000Z", "valid" : true, "message_identification" : "MessageID2", "responder_investigation_identification" : "ResponderInvID1", "investigation_status" : "CLSD", "original_investigation_reason" : "CCNR", "response_data" : { "confirmation" : { "amount" : { "currency" : "USD", "amount" : "100000" }, "credit_debit_indicator" : "CRDT", "account" : { "identification" : { "other_identification" : "Acct123" }, "currency" : "USD" }, "booking_date" : "2024-01-21", "value_date" : "2024-01-21", "references" : { "instruction_identification" : "OrigInstrID1", "end_to_end_identification" : "OrigE2EID1", "uetr" : "20ebf92f-4e95-4359-9bc0-3bb9f9507605" } } }, "original_investigation_request" : { "message_identification" : "OrigMessageID1", "requestor_investigation_identification" : "ReqInvID1", "responder_investigation_identification" : "ResponderInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286", "investigation_type" : "CCNR", "underlying_instrument" : "xbct", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX" } } ], "investigation_tracking_data" : [ { "network_reference" : "20240121132213436-010000000020", "message_identification" : "NotifMessageID1", "message_name_identification" : "NotificationInformation", "from" : "TRCKCHZZXXX", "to" : "BANKUS33XXX", "event_creation_date_time" : "2024-01-21T15:00:00.000Z", "investigation_tracking_status" : "ASGN", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "tracked_message_identification" : { "message_identification" : "OrigMessageID1", "message_name_identification" : "InvestigationRequest", "creation_date_time" : "2024-01-21T15:00:00.000Z" }, "investigation_identification" : { "requestor_investigation_identification" : "ReqInvID1", "responder_investigation_identification" : "ResponderInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286" } }, { "network_reference" : "20240121132213436-010000000021", "message_identification" : "NotifMessageID2", "message_name_identification" : "NotificationInformation", "from" : "TRCKCHZZXXX", "to" : "BANKUS33XXX", "event_creation_date_time" : "2024-01-21T15:15:00.000Z", "investigation_tracking_status" : "DTRP", "requestor" : "BANKUS33XXX", "responder" : "BANKFRPPXXX", "tracked_message_identification" : { "message_identification" : "OrigMessageID1", "message_name_identification" : "InvestigationRequest", "creation_date_time" : "2024-01-21T15:00:00.000Z" }, "investigation_identification" : { "requestor_investigation_identification" : "ReqInvID1", "responder_investigation_identification" : "ResponderInvID1", "eir" : "54a2ae81-c9eb-4c47-9ef3-e9d592f52286" } } ] } ] } ] } } }, "securitySchemes" : { "oauthBearerToken" : { "type" : "http", "scheme" : "bearer", "bearerFormat" : "opaque OAuth 2.0", "description" : "The access token obtained as a result of OAuth 2.0 flows. SWIFT supports two OAuth grant types depending on the API service.\n* JWT-Bearer grant type [RFC 7523](https://tools.ietf.org/html/rfc7523)\n* Password grant type\n\nThis API uses JWT-Bearer grant type.\n\nPlease visit [SWIFT OAuth Token API](https://developer.swift.com/swift-oauth-token-api) page for more information and examples on how to generate an OAuth token.\nIn this declaration only the basic security element to transport the bearer token of an OAuth2 process is declared." } } }, "security" : [ { "oauthBearerToken" : [ ] } ] }