Will return 400 http status Code, if the \"currency\" is not valid ISO 4217 value.
Parameter included in specification for forward compatibility.
Currently and valid value provided in the \"currency\" parameter will be ignored. Payments in GBP will be returned. ", "required": false, "schema": { "type": "string" }, "example": "GBP" }, { "name": "instructionId", "in": "query", "description": "Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. \n \nThe instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. \n
Available values: RETURN_PAYMENT, CUSTOMER_PAYMENT, INTERBANK_PAYMENT, INTERBANK_COV. \n\nSee the table below to understand the mapping between pacs messages and the allowable values. \n
| pacs message | allowable value |
|---|---|
| pacs.004 | RETURN_PAYMENT |
| pacs.008 | CUSTOMER_PAYMENT |
| pacs.009(COV) | INTERBANK_COV |
| pacs.009 | INTERBANK_PAYMENT |
Available values: Settled", "required": false, "schema": { "pattern": "^(Settled)$", "type": "string" }, "example": "Settled" }, { "name": "limit", "in": "query", "description": "Number of items to return in a page. (Default 20)", "required": false, "schema": { "maximum": 500, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "before", "in": "query", "description": "Cursor of item to return records after", "required": false, "schema": { "type": "string" } }, { "name": "after", "in": "query", "description": "Cursor of item to return records before", "required": false, "schema": { "type": "string" } }, { "name": "x-subject", "in": "header", "description": "The header of the API request provides Security Certificate Details (SSL) of the participants.\n\nThe participants need not to send this value. ", "required": false, "schema": { "type": "string" }, "example": "cn=tom,o=zyazgb50,o=swift" }, { "name": "Accept-Encoding", "in": "header", "description": "The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the participant is able to understand. Using content negotiation, the BoE selects one of the proposals, uses it and informs the participants of its choice with the Content-Encoding response header. \n\nMultiple algorithms, weighted with the quality value syntax- \"Accept-Encoding:gzip;q=1.0,*;q=0\"", "required": false, "schema": { "type": "string" }, "example": "gzip;q=1.0,*;q=0" }, { "name": "x-userContext", "in": "header", "description": "User context is in base64 format. It will include the institution BIC. Participants do not need to send this value. This will be populated at Network Level.", "required": false, "schema": { "type": "string", "format": "byte" }, "example": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImN1cmwgLXYgbGRhcDovL0RJUkwwMS5zd2lmdG5ldC5zaXBuLnN3aWZ0LmNvbTozODkvY249dHNzY2hhbm5lbCxvPXN3bGliZWIzLG89c3dpZnQ/dXNlckNlcnRpZmljYXRlIiwidHlwIjoiSldUIn0=" }, { "name": "x-journeyId", "in": "header", "description": "Used to uniquely identify end to end journey of the API request. If header is provided in the request, then the same will be replayed in response headers. This will be populated at Network Level.", "required": false, "schema": { "maxLength": 64, "minLength": 64, "type": "string" }, "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" }, { "name": "X-Forwarded-Host", "in": "header", "description": "Identifies the original host and port requested by the client in the Host HTTP request header. If no port is included, the default port for the service requested is implied. This will be populated at Network Level.", "required": false, "schema": { "pattern": "^[-a-zA-Z0-9@:%._+~#]{2,256}(:[0-9]{2,4})*$", "type": "string" }, "example": "example.com:8080" }, { "name": "X-Forwarded-Path", "in": "header", "description": "Identifies the original URL path requested by the client, including any query string. This will be populated at Network Level. ", "required": false, "schema": { "type": "string" }, "example": "/boe-rtgs-api/resource-mgmt/v1/resources?parentName=eq%3Aparent" } ], "responses": { "200": { "description": "OK", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } }, "Cache-Control": { "description": "Holds directives (instructions) for caching in responses. No caching done from API gateway side. ", "style": "simple", "schema": { "type": "string", "example": "no-cache, no-store, no-transform" } }, "Content-Encoding": { "description": "Optional header provided if Accepted- string Encoding is present in the request.", "style": "simple", "schema": { "type": "string", "example": "gzip" } }, "Content-Language": { "description": "Describes the language(s) intended for the audience. Allowed values: \"en-GB\".", "style": "simple", "schema": { "type": "string", "example": "en-GB" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RawPaymentMessagesSingleResponseListRawPaymentMessages_OperatorListEndpoints" } } } }, "400": { "description": "Bad request", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } }, "Cache-Control": { "description": "Holds directives (instructions) for caching in responses. No caching done from API gateway side. ", "style": "simple", "schema": { "type": "string", "example": "no-cache, no-store, no-transform" } }, "Content-Language": { "description": "Describes the language(s) intended for the audience. Allowed values: \"en-GB\".", "style": "simple", "schema": { "type": "string", "example": "en-GB" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIErrorResponseWrapperDTO_OperatorListEndpoints" }, "example": { "error": { "status": "400", "id": "a1aa1111-1a11-1111-11a1-1aa1aa111a13", "detail": "Invalid Request parameter", "errors": [ { "errorCode": "EAPIGTW2002", "detail": "Invalid id ", "path": "Data.Initiation.Payment.Currency", "uri": "/v2/rawPaymentMessages?settlementDate%3D2021-06-11" } ] } } } } }, "401": { "description": "Unauthorized", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "403": { "description": "Forbidden", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "404": { "description": "Record not found", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } }, "Cache-Control": { "description": "Holds directives (instructions) for caching in responses. No caching done from API gateway side. ", "style": "simple", "schema": { "type": "string", "example": "no-cache, no-store, no-transform" } }, "Content-Language": { "description": "Describes the language(s) intended for the audience. Allowed values: \"en-GB\".", "style": "simple", "schema": { "type": "string", "example": "en-GB" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIErrorResponseWrapperDTO_OperatorListEndpoints" }, "example": { "error": { "status": "404", "id": "a1aa1111-1a11-1111-11a1-1aa1aa111a15", "detail": "Record not found", "errors": [ { "errorCode": "EAPIGTW2017", "detail": "Record does not exist for given ID : 88" } ] } } } } }, "405": { "description": "Method not allowed", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "406": { "description": "Not acceptable", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "429": { "description": "Too many request", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "500": { "description": "Internal server error", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } } }, "path": "/rawPaymentMessages", "method": "GET" } }, "/rawPaymentMessages/{systemId}": { "get": { "tags": [ "Single CHAPS Raw Payment Message" ], "summary": "Single CHAPS Raw Payment Message.", "description": "Given a systemId (as obtained by the rawPaymentMessages endpoint) this endpoint retrieves the base64 encoded raw MX message along with its key information (Settlement Date/Time, Creation Date/Time, UETR, Instructing and Instructed Agent IDs, Amount, Currency, Status and Type)\n\nNote: The samples provided below are illustrative static examples of the response payload from these endpoints. These endpoints are not currently active and hence do not generate real-time responses. Please refrain from using the \"Try it out\" option at the moment. The taskApiPath is not applicable for this endpoint.", "operationId": "getPaymentMessage", "parameters": [ { "name": "x-subject", "in": "header", "description": "The header of the API request provides Security Certificate Details (SSL) of the participants.\n\nThe participants need not to send this value. ", "required": false, "schema": { "pattern": "^[A-Za-z0-9-\\s]{1,64}$", "type": "string" }, "example": "cn=tom,o=zyazgb50,o=swift" }, { "name": "Accept-Encoding", "in": "header", "description": "The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the participant is able to understand. Using content negotiation, the BoE selects one of the proposals, uses it and informs the participants of its choice with the Content-Encoding response header. \n\nMultiple algorithms, weighted with the quality value syntax- \"Accept-Encoding:gzip;q=1.0,*;q=0\"", "required": false, "schema": { "type": "string" }, "example": "gzip;q=1.0,*;q=0" }, { "name": "systemId", "in": "path", "description": "The unique identifier of a single payment message. ", "required": true, "schema": { "pattern": "^[A-Za-z0-9-\\s]{1,64}$", "type": "string" }, "example": "210125083047210721AAMDQAAAAAAA866854844." }, { "name": "x-userContext", "in": "header", "description": "User context is in base64 format. It will include the institution BIC. Participants do not need to send this value. This will be populated at Network Level.", "required": false, "schema": { "type": "string", "format": "byte" }, "example": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImN1cmwgLXYgbGRhcDovL0RJUkwwMS5zd2lmdG5ldC5zaXBuLnN3aWZ0LmNvbTozODkvY249dHNzY2hhbm5lbCxvPXN3bGliZWIzLG89c3dpZnQ/dXNlckNlcnRpZmljYXRlIiwidHlwIjoiSldUIn0=" }, { "name": "x-journeyId", "in": "header", "description": "Used to uniquely identify end to end journey of the API request. If header is provided in the request, then the same will be replayed in response headers. This will be populated at Network Level.", "required": false, "schema": { "maxLength": 64, "minLength": 64, "type": "string" }, "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" }, { "name": "X-Forwarded-Host", "in": "header", "description": "Identifies the original host and port requested by the client in the Host HTTP request header. If no port is included, the default port for the service requested is implied. This will be populated at Network Level.", "required": false, "schema": { "pattern": "^[-a-zA-Z0-9@:%._+~#]{2,256}(:[0-9]{2,4})*$", "type": "string" }, "example": "example.com:8080" }, { "name": "X-Forwarded-Path", "in": "header", "description": "Identifies the original URL path requested by the client, including any query string. This will be populated at Network Level. ", "required": false, "schema": { "type": "string" }, "example": "/boe-rtgs-api/resource-mgmt/v1/resources?parentName=eq%3Aparent" } ], "responses": { "200": { "description": "OK", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } }, "Cache-Control": { "description": "Holds directives (instructions) for caching in responses. No caching done from API gateway side. ", "style": "simple", "schema": { "type": "string", "example": "no-cache, no-store, no-transform" } }, "Content-Encoding": { "description": "Optional header provided if Accepted- string Encoding is present in the request.", "style": "simple", "schema": { "type": "string", "example": "gzip" } }, "Content-Language": { "description": "Describes the language(s) intended for the audience. Allowed values: \"en-GB\".", "style": "simple", "schema": { "type": "string", "example": "en-GB" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RawPaymentMessagesSingleSingleResponseRawPaymentMessages_OperatorSingleEndpoints" } } } }, "400": { "description": "Bad request", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } }, "Cache-Control": { "description": "Holds directives (instructions) for caching in responses. No caching done from API gateway side. ", "style": "simple", "schema": { "type": "string", "example": "no-cache, no-store, no-transform" } }, "Content-Language": { "description": "Describes the language(s) intended for the audience. Allowed values: \"en-GB\".", "style": "simple", "schema": { "type": "string", "example": "en-GB" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIErrorResponseWrapperDTO_OperatorSingleEndpoints" }, "example": { "error": { "status": "400", "id": "a1aa1111-1a11-1111-11a1-1aa1aa111a13", "detail": "Invalid Request parameter", "errors": [ { "errorCode": "EAPIGTW2002", "detail": "Invalid id ", "path": "Data.Initiation.Payment.Currency", "uri": "/v2/rawPaymentMessages?settlementDate%3D2021-06-11" } ] } } } } }, "401": { "description": "Unauthorized", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "403": { "description": "Forbidden", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "404": { "description": "Record not found", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } }, "Cache-Control": { "description": "Holds directives (instructions) for caching in responses. No caching done from API gateway side. ", "style": "simple", "schema": { "type": "string", "example": "no-cache, no-store, no-transform" } }, "Content-Language": { "description": "Describes the language(s) intended for the audience. Allowed values: \"en-GB\".", "style": "simple", "schema": { "type": "string", "example": "en-GB" } } }, "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIErrorResponseWrapperDTO_OperatorSingleEndpoints" }, "example": { "error": { "status": "404", "id": "a1aa1111-1a11-1111-11a1-1aa1aa111a15", "detail": "Record not found", "errors": [ { "errorCode": "EAPIGTW2017", "detail": "Record does not exist for given ID : 88" } ] } } } } }, "405": { "description": "Method not allowed", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "406": { "description": "Not acceptable", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "429": { "description": "Too many request", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } }, "500": { "description": "Internal server error", "headers": { "x-journeyId": { "description": "Used to identify end to end journey of the API request.", "style": "simple", "schema": { "type": "string", "example": "721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92" } } } } }, "path": "/rawPaymentMessages/{systemId}", "method": "GET" } } }, "components": { "schemas": { "CursorPaginatedListResponseSchemaWithReqParamsRawPaymentMessagesRequestParametersRawPaymentMessages_OperatorListEndpoints": { "title": "CursorPaginatedListResponseSchemaWithReqParams", "type": "object", "properties": { "requestParameters": { "type": "array", "items": { "$ref": "#/components/schemas/RawPaymentMessagesRequestParameters_OperatorListEndpoints" } }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RawPaymentMessages_OperatorListEndpoints" } } } }, "CursorResponseLinksSchemaRawPaymentMessages_OperatorListEndpoints": { "title": "Links", "required": [ "first", "self" ], "type": "object", "properties": { "self": { "type": "string", "description": "A URL to reproduce the current request.", "example": "{apiPath}/v2/resource?after={value}" }, "first": { "type": "string", "description": "A URL to retrieve the first page of resources.", "example": "{apiPath}/v2/resource" } } }, "RawPaymentMessagesRequestParameters_OperatorListEndpoints": { "title": "ReqParameters", "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Parameter name used in API request by participants. ", "example": "instructedAgentId" }, "value": { "type": "string", "description": "Parameter value provided in API request by participants. ", "example": "YQQYGB30XXX. " } } }, "RawPaymentMessagesSingleResponseListRawPaymentMessages_OperatorListEndpoints": { "title": "RawPaymentMessagesResponseList", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CursorPaginatedListResponseSchemaWithReqParamsRawPaymentMessagesRequestParametersRawPaymentMessages_OperatorListEndpoints" }, "links": { "$ref": "#/components/schemas/CursorResponseLinksSchemaRawPaymentMessages_OperatorListEndpoints" } } }, "RawPaymentMessages_OperatorListEndpoints": { "title": "RawPaymentMessages", "required": [ "amount", "businessService", "creationDate", "creationTime", "currency", "href", "instructedAgentId", "instructingAgentId", "instructionId", "messageDefinitionId", "settlementDate", "settlementTime", "status", "systemId", "type", "uetr" ], "type": "object", "properties": { "systemId": { "pattern": "^[A-Za-z0-9-\\s]{1,64}$", "type": "string", "description": "The unique identifier of a single payment message. ", "example": "65cb18a4ac8a76c1fae5360f206db6ed22fee016d2ccaba8c7b6b8272b91ebf1" }, "instructingAgentId": { "pattern": "[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3}){0,1}$", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. ", "example": "ZYAZGB50XXX" }, "instructedAgentId": { "pattern": "[A-Z0-9]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3}){0,1}$", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. ", "example": "YQQYGB30XXX" }, "settlementDate": { "type": "string", "description": "Date at which a transaction is completed and cleared, that is, payment is effected. ", "format": "date", "example": "2021-01-01" }, "settlementTime": { "type": "string", "description": "Time at which a transaction is completed and cleared, that is, payment is effected. ", "example": "16:50:27Z" }, "creationDate": { "type": "string", "description": "Date on which the message was created. ", "format": "date", "example": "2021-01-01" }, "creationTime": { "type": "string", "description": "Time at which the message was created. ", "example": "16:50:00Z" }, "amount": { "multipleOf": 0.0001, "maximum": 1000000000000, "minimum": 1, "type": "number", "description": "Total amount of money moved between the instructing agent (Sender) and the instructed agent (Receiver) . ", "example": 13.99 }, "currency": { "pattern": "^[A-Z]{3}$", "type": "string", "description": "Medium of exchange of value. ", "example": "GBP" }, "instructionId": { "pattern": "^[0-9a-zA-Z/\\-\\?:\\(\\)\\.,'\\+ ]{1,16}$", "type": "string", "description": "Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. ", "example": "InsID8b445468595" }, "messageDefinitionId": { "type": "string", "description": "MessageIdentifier that defines the BusinessMessage. See the table below to understand the mapping between pacs messages and the allowable values. \n
| pacs message | allowable value |
|---|---|
| pacs.004 | RETURN_PAYMENT |
| pacs.008 | CUSTOMER_PAYMENT |
| pacs.009(COV) | INTERBANK_COV |
| pacs.009 | INTERBANK_PAYMENT |
| pacs message | allowable value |
|---|---|
| pacs.004 | RETURN_PAYMENT |
| pacs.008 | CUSTOMER_PAYMENT |
| pacs.009(COV) | INTERBANK_COV |
| pacs.009 | INTERBANK_PAYMENT |