openapi: 3.0.1 info: title: Bank of England RTGS Participants API version: 1.15.0 description: >- A Participant is an organisation that holds an Account within the RTGS service, and is legally bound by the published RTGS Account Mandate Terms & Conditions. The Bank of England RTGS Participants API enables an organisation to: - Retrieve a list of participants - Retrieve CHAPS Payments Controls - Retrieves Payment Parameters - Update Payment Parameters - Retrieves CHAPS Payments Balances - Retrieves CREST Payments Balances - Retrieves Notification Configuration Preferences - Update Notification Configuration Preferences - Retrieves Scheme Memberships contact: email: APITeam@bankofengland.co.uk name: RTGS API team license: url: https://www.bankofengland.co.uk/payment-and-settlement name: >- Please refer to the API Annex under the "Requirements for use of RTGS accounts" section servers: - url: >- https://api-test.swiftnet.sipn.swift.com/boe-rtgs-api-pilot-i1/participant-mgmt/np4/v1 description: NP4 Environment (Non-Prod) variables: apiPath: default: /boe-rtgs-api-pilot-i1/participant-mgmt/np4 taskApiPath: default: /boe-rtgs-api-pilot-i1/task-mgmt/np4 - url: >- https://api-test.swiftnet.sipn.swift.com/boe-rtgs-api-pilot-i1/participant-mgmt/np5/v1 description: NP5 Environment (Non-Prod) variables: apiPath: default: /boe-rtgs-api-pilot-i1/participant-mgmt/np5 taskApiPath: default: /boe-rtgs-api-pilot-i1/task-mgmt/np5 - url: >- https://api-test.swiftnet.sipn.swift.com/boe-rtgs-api-pilot-i2/participant-mgmt/pp2/v1 description: PP2 Environment (Dress-Rehearsals) variables: apiPath: default: /boe-rtgs-api-pilot-i2/participant-mgmt/pp2 taskApiPath: default: /boe-rtgs-api-pilot-i2/task-mgmt/pp2 - url: >- https://api-test.swiftnet.sipn.swift.com/boe-rtgs-api-pilot-i3/participant-mgmt/pp2/v1 description: PP2 Environment (Pre-Prod) variables: apiPath: default: /boe-rtgs-api-pilot-i3/participant-mgmt/pp2 taskApiPath: default: /boe-rtgs-api-pilot-i3/task-mgmt/pp2 - url: https://api.swiftnet.sipn.swift.com/boe-rtgs-api/participant-mgmt/v1 description: Live Environment (Prod) variables: apiPath: default: /boe-rtgs-api/participant-mgmt taskApiPath: default: /boe-rtgs-api/task-mgmt paths: /participants/{participantId}/paymentParameters: get: tags: - Participants summary: >- Retrieves a specific participant's payment parameters detail based on the participant Id. description: >- Payment Parameters are capabilities provided to the participants to manage CHAPS transaction parameters, including: bilateral limit, bilateral brake, bilateral value cap, and scheme value cap. This endpoint allows the consumer to retrieve a specific participant's payment parameters based on the participant id, that the consumer is authorised to. By default, the data is sorted by the counterPartyId field in an ascending order. Note: The participant Id can be obtained using the '/participants' endpoint. operationId: getParticipantPaymentParameters parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - name: limit in: query description: >- Number of items to return in a page. Must be greater than or equal to 1 (Default 20) required: false schema: maximum: 500 minimum: 1 type: integer format: int32 example: 20 - name: offset in: query description: >- The number of the record to start the page from. Must be greater than 0 and less than 2147483647 (The maximum value for an integer). The default value is 0. required: false schema: maximum: 2147483647 minimum: 0 type: integer format: int64 example: 0 - name: sort in: query description: >- Order to sort results in [direction][field] where direction is +(ascending) or -(descending) required: false schema: type: string example: +id - name: counterPartyId in: query description: >- Used to filter payment parameters based on the counter party id. A unique Id for the counter party in the RTGS. Accepts multiple values. Only supports Equal(eq). required: false schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120022 - name: counterPartyShortName in: query description: >- Used to filter payment parameters based on the counter party short name. Short Name of the organisations / participants in the RTGS. Accepts multiple values. Only supports Equal(eq). required: false schema: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,15}$ type: string example: BA03 - name: counterPartyFullName in: query description: >- Used to filter payment parameters based on the counter party full name. Full Name of the organisations / participants in the RTGS. Accepts multiple values. Only supports Equal(eq). required: false schema: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string example: Barclays Bank - name: queuedDebitsVolume in: query description: >- Used to filter payment parameters based on the queued debits volume. Number of queued debit transactions in RTGS which have not yet settled for the value day. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: number example: 10 - name: queuedDebitsValue in: query description: >- Used to filter payment parameters based on the queued debits value. Sum of queued debit transactions in RTGS which have not yet settled for the value day. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: number example: 10.88 - name: queuedCreditsVolume in: query description: >- Used to filter payment parameters based on the queued credits volume. Number of queued credit transactions in RTGS which have not yet settled for the value day. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: number example: 10 - name: queuedCreditsValue in: query description: >- Used to filter payment parameters based on the queued credits value. Sum of queued credit transactions in RTGS which have not yet settled for the value day. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: number example: 10.88 - name: transactionLastReceived in: query description: >- Used to filter payment parameters based on when the last transaction was received. Date and time at which the last transaction was received. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: string format: date-time example: '2022-05-22T12:10:10.213212Z' - name: transactionLastSent in: query description: >- Used to filter payment parameters based on when the last transaction was sent. Date and time at which the last transaction was sent. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: string format: date-time example: '2022-05-22T12:12:10.213212Z' - name: hasBilateralBrake in: query description: >- Used to filter payment parameters based on the bilateral brake. Bilateral brake is used to pause the payments between the participant organisations. Only supports Equal (eq). required: false schema: type: boolean example: true - name: bilateralPosition in: query description: >- Used to filter payment parameters based on the bilateral position. The sum of total settled CHAPS credits subtracted by the total settled CHAPS debits against the counter party for the value day in RTGS. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: number example: 50.67 - name: bilateralLimit in: query description: >- Used to filter payment parameters based on the bilateral limit. A limit set on a Participant's maximum net debit position against a single counter party. Note: if this filter is used, it must be provided as a range. Can support Less than (lt), Less than or equal (lte), Greater than (gt) and greater than or Equal (gte) required: false schema: type: number example: 45.66 - 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: Participants 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/PaymentParameterResponseList_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: Constraint Violation - Path Variable(s) errors: - errorCode: EAPIGTW2002 detail: 'Invalid id provided: TT' '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: /participants/{participantId}/paymentParameters method: GET patch: tags: - Participants summary: Update the specific participant's payment parameters details. description: >- Payment Parameters are capabilities provided to the participants to manage CHAPS transaction parameters, including: bilateral limit, bilateral brake, bilateral value cap, and scheme value cap. This endpoint allows the consumer to update a specific participant's payment parameters based on the participant id, that the consumer is authorised to. The consumer needs to pass the old value and new value, to be able to update successfully. Note: The participant Id can be obtained using the '/participants' endpoint. Note: In this case, the resource Id will be the same as payment parameter Id. operationId: updatePaymentParameters parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - 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 requestBody: content: application/json: schema: $ref: >- #/components/schemas/APIBulkRequestDataWrapperUpdateBulkValuesWrapperPaymentParameterString_UpdateEndpoints required: true responses: '202': description: Accepted 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/WriteResponseNonAtomicSchema_UpdateEndpoints '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_UpdateEndpoints example: error: status: '400' id: a1aa1111-1a11-1111-11a1-1aa1aa111a14 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Invalid full name provided '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_UpdateEndpoints 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 '409': description: Data conflict 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_UpdateEndpoints example: error: status: '409' id: a1aa1111-1a11-1111-11a1-1aa1aa111a16 detail: Data conflict errors: - errorCode: EAPIGTW2031 detail: >- In-flight Task Ref : D04NOTES-ABCD-01 exists for Resource ID : a4faa192-ddd7-11ed-b5ea-0242ac120021 '415': description: Unsupported media type 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: /participants/{participantId}/paymentParameters method: PATCH /participants/{participantId}/notificationConfigurations: get: tags: - Participants summary: >- Retrieves a specific participant organisation's notification configuration preferences detail based on the participant Id. description: >- Notification configurations are capabilities provided to the participants to manage their notification preferences by opting in or opting out for each notification type including: window open, window closed, queue blocked, queue unblocked, account report failed, TAB boundary breached and task notifications, with some exceptions. Task, queue blocked and queue unblocked notifications are mandatory. This endpoint allows the consumer to retrieve a participant organisation's notification configuration preferences detail based on the participant Id, that the consumer is authorised to. If a participant has opted in to receive notifications via either UI or SWIFT (or both), they will also be able to retrieve those notifications via API channel. Note: The participant Id can be obtained using the '/participants' endpoint. By default, the data is sorted by notificationTypeCode field in an ascending order. operationId: getNotificationConfigurations parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - 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: Notification Configuration preference 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/NotificationConfigurationListResponse_ParticipantListEndpoints '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_ParticipantListEndpoints example: error: status: '400' id: a1aa1111-1a11-1111-11a1-1aa1aa111a12 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Limit parameter is less than 1 '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_ParticipantListEndpoints 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: /participants/{participantId}/notificationConfigurations method: GET patch: tags: - Participants summary: >- Update the specific participant organisation's notification configuration preferences detail based on the participant id. description: >- Notification configurations are capabilities provided to the participants to manage their notification configurations by opting in or opting out for each notification type including: window open, window closed, queue blocked, queue unblocked, account report failed, TAB boundary breached and task notifications, with some exceptions. Task, queue blocked and queue unblocked notifications are mandatory. This endpoint allows the consumer to update a specific participant organisation's notification configuration preferences detail based on the participant id, that the consumer is authorised to. The consumer needs to pass the old value and new value, to be able to update successfully. Note: The participant Id can be obtained using the '/participants' endpoint. operationId: updateNotificationConfigurations parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - 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 requestBody: content: application/json: schema: $ref: >- #/components/schemas/APIBulkRequestDataWrapperUpdateBulkValuesWrapperNotificationConfigurationString_UpdateEndpoints required: true responses: '202': description: Accepted 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/WriteResponseNonAtomicSchema_UpdateEndpoints '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_UpdateEndpoints example: error: status: '400' id: a1aa1111-1a11-1111-11a1-1aa1aa111a14 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Invalid full name provided '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_UpdateEndpoints 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 '409': description: Data conflict 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_UpdateEndpoints example: error: status: '409' id: a1aa1111-1a11-1111-11a1-1aa1aa111a16 detail: Data conflict errors: - errorCode: EAPIGTW2031 detail: >- In-flight Task Ref : D04NOTES-ABCD-01 exists for Resource ID : a4faa192-ddd7-11ed-b5ea-0242ac120021 '415': description: Unsupported media type 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: /participants/{participantId}/notificationConfigurations method: PATCH /participants: get: tags: - Participants summary: Retrieves the details of a list of participants. description: >- A Participant is an organisation who holds an Account within the RTGS service, and is legally bound by the published RTGS Account Mandate Terms & Conditions. This endpoint allows the consumer to retrieve the details of a list of participants, that the consumer is authorised to. By default, the data is sorted by the participantId field in an ascending order. operationId: getParticipants parameters: - name: participantId in: query description: >- Used to filter participants based on participant id. A unique ID for the participant in the RTGS. Accepts multiple values. Only supports Equal(eq). Possible values can be fetched from "GET /filterValues?resourceName=participants" endpoint. required: false schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - name: participantFullName in: query description: >- Used to filter participants based on participant full name. Full Name of the organisations / participants in the RTGS. Only supports Equal(eq). required: false schema: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string example: Barclays Bank - name: participantBusinessTypeCode in: query description: >- Used to filter participants based on participant business type code. Identifier of the business type of which the RTGS participant belongs to. Only supports Equal(eq). Note: this filter is not applicable for participants. required: false schema: pattern: ^[A-Z_]{1,35}$ type: string - name: participantStatusCode in: query description: >- Used to filter participants based on participant status code. Determines the status of the Participant record within RTGS. Only supports Equal(eq). Note: this filter is not applicable for participants. required: false schema: pattern: ^[A-Z_]{1,35}$ type: string - name: limit in: query description: >- Number of items to return in a page. Must be greater than or equal to 1 (Default 20) required: false schema: maximum: 500 minimum: 1 type: integer format: int32 example: 20 - name: offset in: query description: >- The number of the record to start the page from. Must be greater than 0 and less than 2147483647 (The maximum value for an integer). The default value is 0. required: false schema: maximum: 2147483647 minimum: 0 type: integer format: int64 example: 0 - name: sort in: query description: >- Order to sort results in [direction][field] where direction is +(ascending) or -(descending) required: false schema: type: string example: +id - 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: Participants 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/ParticipantResponseList' '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' example: error: status: '400' id: a1aa1111-1a11-1111-11a1-1aa1aa111a12 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Limit parameter is less than 1 '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' 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: /participants method: GET /participants/{participantId}/schemeMemberships: get: tags: - Participants summary: >- Retrieves scheme memberships of an individual participant based on the provided participant Id. description: >- Scheme Memberships are the different payment schemes like CHAPS, CREST, DNS etc. to which RTGS Participants are member of and participate in. The scheme determines the rules that are applied to transactions as they are processed through RTGS. This endpoint retrieves scheme memberships of an individual participant based on the passed Participant Id. By default, the data is sorted by the schemeMembershipId field in an ascending order. Note: the participant id can be retrieved via 'GET /participants endpoint'. operationId: getParticipantSchemeMemberships parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - name: limit in: query description: >- Number of items to return in a page. Must be greater than or equal to 1 (Default 20) required: false schema: maximum: 500 minimum: 1 type: integer format: int32 example: 20 - name: offset in: query description: >- The number of the record to start the page from. Must be greater than 0 and less than 2147483647 (The maximum value for an integer). The default value is 0. required: false schema: maximum: 2147483647 minimum: 0 type: integer format: int64 example: 0 - name: sort in: query description: >- Order to sort results in [direction][field] where direction is +(ascending) or -(descending) required: false schema: type: string example: +id - 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: Scheme Memberships found headers: x-journeyId: description: Used to identify end to end journey of the API request. style: simple schema: type: string example: >- 721C04F0B91A53908E4233D56E07E35D7C62AE63B881DD50B24FF19315CB4F92 x-retrievedAt: description: Date and time of when the content was retrieved. style: simple schema: type: string example: 2023-03-13T18:04Z 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/ParticipantSchemeMembershipResponseList_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 x-retrievedAt: description: Date and time of when the content was retrieved. style: simple schema: type: string example: 2023-03-13T18:04Z 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-1aa1aa111a12 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Limit parameter is less than 1 '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 x-retrievedAt: description: Date and time of when the content was retrieved. style: simple schema: type: string example: 2023-03-13T18:04Z 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: /participants/{participantId}/schemeMemberships method: GET /participants/{participantId}/crestPaymentsBalances: get: tags: - Participants summary: >- Retrieves a specific participant organisation's CREST payments balances detail based on the participant Id. description: >- CREST Payment Balances provides details of the CREST settlement attributes i.e. Settlement Account Balance, Repo Balance and CREST Settlement Liquidity Group Balance. This endpoint allows the consumer to retrieve the CREST Payments Balances details based on the participant id, that the consumer is authorised to. operationId: getCrestPaymentsBalances parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - 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: CREST Payments Balances 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/CrestPaymentsBalanceSingleResponse_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-1aa1aa111a12 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Limit parameter is less than 1 '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: /participants/{participantId}/crestPaymentsBalances method: GET /participants/{participantId}/chapsPaymentsControls: get: tags: - Participants summary: >- Retrieves a specific participant organisation's CHAPS payments controls detail based on the participant id. description: >- CHAPS Payments Controls allows the account owner to manage the configuration of the settlement attributes Headroom Balance, Non Urgent Balance, Max Headroom, Headroom Refresh, Multilateral Limit, Value Cap and Auto Promote Delay for effective processing of CHAPS transactions. This endpoint allows the consumer to retrieve the CHAPS Payments Controls detail based on the participant id, that the consumer is authorised to. Note: The participant Id can be obtained using the List of Participants endpoint. operationId: getChapsPaymentsControl parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - 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: Chaps Payment Control 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/ChapsPaymentsControlSingleResponse_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: Constraint Violation - Path Variable(s) errors: - errorCode: EAPIGTW2002 detail: 'Invalid id provided: TT' '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: /participants/{participantId}/chapsPaymentsControls method: GET /participants/{participantId}/chapsPaymentsBalances: get: tags: - Participants summary: >- Retrieves a specific participant organisation's CHAPS Payments Balances detail based on the participant Id. description: >- CHAPS Payments Balances provides details of the payment attributes i.e. scheme value day status code, next scheduled at, queued debits volume, queued debits value, queued credits volume, queued credits value, settled debits volume, settled debits value, settled credits volume, settled credits value, settlement amount balance, liquidity account balance, settlement liquidity group balance and projected settlement liquidity group balance for effective management of CHAPS payment balances. This endpoint allows the consumer to retrieve the CHAPS Payments Balances detail based on the participant id, that the consumer is authorised to. Note: The participant Id can be obtained using the List of Participants endpoint. operationId: getChapsPaymentsBalances parameters: - name: participantId in: path description: 'A unique ID for the participant in the RTGS. ' required: true schema: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string example: a4faa192-ddd7-11ed-b5ea-0242ac120002 - 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: CHAPS payments balances 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/ChapsPaymentsBalancesSingleResponse_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-1aa1aa111a12 detail: Invalid parameters errors: - errorCode: EAPIGTW2002 detail: Limit parameter is less than 1 '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: /participants/{participantId}/chapsPaymentsBalances method: GET components: schemas: TaskRefDataSchema_UpdateEndpoints: title: Data required: - taskRef type: object properties: taskRef: pattern: ^(?=.{1,35}$)[A-Z0-9]{1,23}-[A-Z0-9]{4}(-\d{1,7})?$ type: string description: >- The general, unique task reference assigned by the RTGS. For non-atomic requests (which generate multiple tasks), this refers to the shared portion of the task reference across all related tasks. To retrieve the associated task(s), use the "GET /tasks" endpoint with the taskRef filter, along with any required filters. For example: "GET /tasks?taskRef=D01UPBULKT-ABCD&createdOn=...&participantId=..." example: D04NOTES-R2D3 APIErrorResponseDTO_UpdateEndpoints: title: APIErrorResponse required: - detail - errors - id - status type: object properties: status: pattern: ^\d{3}$ type: string description: >- Standard HTTP Status code defined in RFC 7231 id: maxLength: 36 minLength: 36 type: string description: >- A unique reference (GUID) for the error instance, for audit purposes and traceability. format: uuid example: fb06dbc9-da8d-4927-b0f8-0eec823aaaa7 detail: type: string description: Brief error message explaining the error errors: type: array items: $ref: '#/components/schemas/ErrorsFragment_UpdateEndpoints' APIErrorResponseWrapperDTO_UpdateEndpoints: title: APIErrorResponseWrapper type: object properties: error: $ref: '#/components/schemas/APIErrorResponseDTO_UpdateEndpoints' ErrorsFragment_UpdateEndpoints: title: ErrorInfo required: - detail - errorCode type: object properties: errorCode: maxLength: 11 minLength: 11 pattern: E[A-Z0-9]{6}[0-9]{4} type: string description: |- Custom Error Code consists of the following example: EAPIGTW2039 detail: type: string description: Description of the error detail with further granularity uri: type: string description: >- URL to help remediate the problem, or provide more information, or to API Reference or help etc. format: uri APIBulkRequestDataWrapperUpdateBulkValuesWrapperPaymentParameterString_UpdateEndpoints: title: APIBulkRequestDataWrapper required: - data type: object properties: data: minItems: 1 type: array items: $ref: >- #/components/schemas/UpdateBulkValuesWrapperPaymentParameterString_UpdateEndpoints FinancialAmount_UpdateEndpoints: title: MonetaryDetail required: - currencyCode type: object properties: amount: maximum: 1e+33 exclusiveMaximum: true minimum: -1e+33 exclusiveMinimum: true type: number description: >- The number of monetary units specified in an active currency. This could be positive or negative amount. Negative amount should start with minus (-) sign. The amount format including decimal fraction should comply as per ISO 4217 currency amount. format: double nullable: true example: 50.65 currencyCode: minLength: 1 pattern: ^[A-Z]{3}$ type: string description: >- Identification of the currency associated to the resource. This should follow the standard ISO 4217 format. Possible values can be fetched from "GET /filterValues?resourceName=currencies" endpoint. example: GBP description: >- The number of monetary units specified in an active currency. This could be positive or negative amount. Negative amount should start with minus (-) sign. The amount format including decimal fraction should comply as per ISO 4217 currency amount. nullable: true PaymentParameter_UpdateEndpoints: title: PaymentParameter required: - bilateralBrakeValueCapId - bilateralBrakeValueCapLastUpdatedOn - bilateralLimitId - bilateralLimitLastUpdatedOn - bilateralPosition - counterPartyId - hasBilateralBrake - participantId - paymentParameterId type: object properties: paymentParameterId: pattern: >- ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}-[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the payment parameter assigned by the RTGS. ' example: >- a4faa192-ddd7-11ed-b5ea-0242ac120002-a4faa192-ddd7-11ed-b5ea-0242ac120003 participantId: minLength: 1 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120012 counterPartyId: minLength: 1 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the counter party in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120022 counterPartyShortName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,15}$ type: string description: 'Short Name of the CHAPS counter party participant in the RTGS. ' nullable: true example: BA03 counterPartyFullName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string description: 'Full Name of the CHAPS counter party participant in the RTGS. ' nullable: true example: Barclays Bank bilateralLimitId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the bilateral limit assigned by the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120032 bilateralLimit: type: array description: >- A limit set on a Participant's maximum net debit position against a single counter party. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' bilateralLimitLastUpdatedOn: type: string description: >- Date and time at which the bilateral limit was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-04-01T12:00:00.123456Z' bilateralPosition: type: array description: >- The sum of total settled CHAPS credits subtracted by the total settled CHAPS debits against the counter party for the value day in RTGS. This field supports up to 2 decimal places. items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' bilateralLimitPercentage: type: number description: >- A percentage which represents the ratio of the Bilateral Position to the bilateral limit. This shows what percentage of Bilateral Limit is available for the participant organisation. This field supports up to 2 decimal places. nullable: true example: 55.55 bilateralAmountAvailable: type: array description: >- Difference between the Bilateral Limit and the Bilateral Position. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' bilateralBrakeValueCapId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the bilateral brake value cap assigned by the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120042 bilateralValueCap: type: array description: >- A limit set on the maximum value for each funds transfer to a specific counter party. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' hasBilateralBrake: type: boolean description: >- Bilateral brake is used to pause the payments between the participant organisations. Flag to indicate whether bilateral brake is enabled or not for a specific counter party. If flag is "true", then bilateral brake is enabled. For authorised consumers, when performing an update, this is an editable field. example: false bilateralBrakeValueCapLastUpdatedOn: type: string description: >- Date and time at which the bilateral brake value cap was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-04-01T12:00:00.123456Z' queuedDebitsVolume: type: integer description: >- Number of queued debit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 10 queuedDebitsValue: type: array description: >- Sum of queued debit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' queuedCreditsVolume: type: integer description: >- Number of queued credit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 20 queuedCreditsValue: type: array description: >- Sum of queued credit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' settledDebitsVolume: type: integer description: >- Number of debit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 15 settledDebitsValue: type: array description: >- Sum of debit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' settledCreditsVolume: type: integer description: >- Number of credit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 25 settledCreditsValue: type: array description: >- Sum of credit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_UpdateEndpoints' transactionLastReceived: type: string description: >- Date and time at which the last transaction was received. This should follow the standard ISO 8601 format with UTC offset. format: date-time nullable: true example: '2022-04-01T12:00:00.123456Z' transactionLastSent: type: string description: >- Date and time at which the last transaction was sent. This should follow the standard ISO 8601 format with UTC offset. format: date-time nullable: true example: '2022-04-01T12:00:00.123456Z' UpdateBulkValuesWrapperPaymentParameterString_UpdateEndpoints: title: UpdateBulkValuesWrapper required: - newValue - oldValue - resourceId type: object properties: resourceId: pattern: ^[A-Za-z0-9\-\s]{1,100}$ type: string description: A unique Id for the resource being updated in the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120002 oldValue: $ref: '#/components/schemas/PaymentParameter_UpdateEndpoints' newValue: $ref: '#/components/schemas/PaymentParameter_UpdateEndpoints' TaskUrlSchema_UpdateEndpoints: title: TaskLinks type: object properties: Task for Resource 1: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/581ddd74-5151-4c74-ad2f-b2196752bbad' Task for Resource 2: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/3d9397d1-e394-4863-be26-0686684bc510' TaskUrlWrapperSchema_UpdateEndpoints: title: Links type: object properties: taskUrl: $ref: '#/components/schemas/TaskUrlSchema_UpdateEndpoints' WriteResponseNonAtomicSchema_UpdateEndpoints: title: Response type: object properties: data: $ref: '#/components/schemas/TaskRefDataSchema_UpdateEndpoints' links: $ref: '#/components/schemas/TaskUrlWrapperSchema_UpdateEndpoints' APIBulkRequestDataWrapperUpdateBulkValuesWrapperNotificationConfigurationString_UpdateEndpoints: title: APIBulkRequestDataWrapper required: - data type: object properties: data: minItems: 1 type: array items: $ref: >- #/components/schemas/UpdateBulkValuesWrapperNotificationConfigurationString_UpdateEndpoints NotificationConfiguration_UpdateEndpoints: title: NotificationConfiguration required: - lastUpdatedAt - notificationConfigurationId - notificationTypeCode - notificationTypeName - participantId - swiftIndicator - uiIndicator type: object properties: notificationConfigurationId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: >- A unique Id for the notification configuration assigned by the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120002 notificationTypeCode: pattern: ^([A-Z0-9]{1,11}|Task0001)$ type: string description: >- Unique code for the type of notification to which the notification preference is associated to in RTGS. example: NCSEINF0001 enum: - NCSEINF0001 - NCSEINF0002 - NCSEINF0025 - NCSEINF0026 - NCSEINF0020 - NCSEINF0017 notificationTypeName: minLength: 1 pattern: ^[A-Za-z\s\/]{1,100}$ type: string description: >- Identifier of the type of notification to which the notification preference is associated to in RTGS. example: Window Open enum: - Window Open - Window Closed - Queue Blocked - Queue Unblocked - Account Report Failed - TAB Boundary Breached uiIndicator: type: boolean description: >- Flag to indicate whether or not a participant organisation will receive the notifications over UI. If set to "true", the UI notification preference will be Opt In and if set to "false", the UI notification preference will be Opt Out. For authorised consumers, when performing an update, this is an editable field. example: true swiftIndicator: type: boolean description: >- Flag to indicate whether or not a participant organisation will receive the notifications over SWIFT network. If set to "true", the SWIFT notification preference will be Opt In and if set to "false", the SWIFT notification preference will be Opt Out. For authorised consumers, when performing an update, this is an editable field. example: true lastUpdatedAt: type: string description: >- Date and time at which the notification configuration preference was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2021-05-22T13:00:00.123456Z' participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 UpdateBulkValuesWrapperNotificationConfigurationString_UpdateEndpoints: title: UpdateBulkValuesWrapper required: - newValue - oldValue - resourceId type: object properties: resourceId: pattern: ^[A-Za-z0-9\-\s]{1,100}$ type: string description: A unique Id for the resource being updated in the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120002 oldValue: $ref: '#/components/schemas/NotificationConfiguration_UpdateEndpoints' newValue: $ref: '#/components/schemas/NotificationConfiguration_UpdateEndpoints' OffsetPaginatedListResponseParticipant: title: OffsetPaginatedListResponse type: object properties: results: type: array items: $ref: '#/components/schemas/Participant' sort: type: string description: The sort direction and the field name used to sort the resources by. example: +id totalRecordCount: type: integer description: The total number of records for a given resource. format: int64 example: 100 offset: type: integer description: Current record count offset for this page. format: int64 example: 0 limit: type: integer description: The total number of records retrieved per page. format: int64 example: 20 OffsetResponseLinksSchema: title: Links required: - first - last - self type: object properties: self: type: string description: A URL to reproduce the current request. example: '{apiPath}/v1/resource?offset=60&limit=20' first: type: string description: A URL to retrieve the first page of resources. example: '{apiPath}/v1/resource?offset=0&limit=20' last: type: string description: A URL to retrieve the last page of resources example: '{apiPath}/v1/resource?offset=300000&limit=20' next: type: string description: A URL to retrieve the next page of resources. example: '{apiPath}/v1/resource?offset=80&limit=20' previous: type: string description: A URL to retrieve the previous page of resources example: '{apiPath}/v1/resource?offset=40&limit=20' taskUrl: $ref: '#/components/schemas/TaskUrlSchema' Participant: title: Participant required: - isActiveChapsDp - isPartyToPartyTransferEnabled - lastUpdatedOn - lei - participantId type: object properties: participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 participantFullName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string description: >- Full Name of the organisations / participants in the RTGS. For authorised consumers, when performing an update, this is an editable field. nullable: true example: Barclays Bank participantShortName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,15}$ type: string description: >- Short Name of the organisations / participants in the RTGS. For authorised consumers, when performing an update, this is an editable field. nullable: true example: BA03 lei: pattern: ^[A-Z0-9]{18}[0-9]{2}$ type: string description: >- Unique global identifier for legal entities participating in financial transactions. This should follow the standard ISO 17442 format. For authorised consumers, when performing an update, this is an editable field. example: AA00BB11CC22DD33EE55 lastUpdatedOn: type: string description: >- Date and time at which the participant was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2021-02-22T12:00:00.123456Z' isPartyToPartyTransferEnabled: type: boolean description: >- Flag to indicate whether a participant is allowed to create a Party to Party Transfer. If the flag is "true", then the participant can create a Party to Party Transfer. For authorised consumers, when performing an update, this is an editable field. example: true isActiveChapsDp: type: boolean description: >- Flag to indicate whether or not the participant has an active CHAPS scheme membership. If the flag is "true", the participant has an active CHAPS scheme membership. example: true readOnly: type: boolean description: >- Flag to indicate whether the resource is editable. If the flag is "true", the request to update/delete a resource will fail. This field will be available on the GET Single Participant endpoint only. nullable: true example: true ParticipantResponseList: title: ParticipantResponseList type: object properties: data: $ref: '#/components/schemas/OffsetPaginatedListResponseParticipant' links: $ref: '#/components/schemas/OffsetResponseLinksSchema' TaskUrlSchema: title: TaskLinks type: object properties: Task for Resource 1: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/581ddd74-5151-4c74-ad2f-b2196752bbad' Task for Resource 2: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/3d9397d1-e394-4863-be26-0686684bc510' APIErrorResponseDTO: title: APIErrorResponse required: - detail - errors - id - status type: object properties: status: pattern: ^\d{3}$ type: string description: >- Standard HTTP Status code defined in RFC 7231 id: maxLength: 36 minLength: 36 type: string description: >- A unique reference (GUID) for the error instance, for audit purposes and traceability. format: uuid example: fb06dbc9-da8d-4927-b0f8-0eec823aaaa7 detail: type: string description: Brief error message explaining the error errors: type: array items: $ref: '#/components/schemas/ErrorsFragment' APIErrorResponseWrapperDTO: title: APIErrorResponseWrapper type: object properties: error: $ref: '#/components/schemas/APIErrorResponseDTO' ErrorsFragment: title: ErrorInfo required: - detail - errorCode type: object properties: errorCode: maxLength: 11 minLength: 11 pattern: E[A-Z0-9]{6}[0-9]{4} type: string description: |- Custom Error Code consists of the following example: EAPIGTW2039 detail: type: string description: Description of the error detail with further granularity uri: type: string description: >- URL to help remediate the problem, or provide more information, or to API Reference or help etc. format: uri OffsetPaginatedListResponseParticipantSchemeMembership_OperatorListEndpoints: title: OffsetPaginatedListResponse type: object properties: results: type: array items: $ref: >- #/components/schemas/ParticipantSchemeMembership_OperatorListEndpoints sort: type: string description: The sort direction and the field name used to sort the resources by. example: +id totalRecordCount: type: integer description: The total number of records for a given resource. format: int64 example: 100 offset: type: integer description: Current record count offset for this page. format: int64 example: 0 limit: type: integer description: The total number of records retrieved per page. format: int64 example: 20 OffsetResponseLinksSchema_OperatorListEndpoints: title: Links required: - first - last - self type: object properties: self: type: string description: A URL to reproduce the current request. example: '{apiPath}/v1/resource?offset=60&limit=20' first: type: string description: A URL to retrieve the first page of resources. example: '{apiPath}/v1/resource?offset=0&limit=20' last: type: string description: A URL to retrieve the last page of resources example: '{apiPath}/v1/resource?offset=300000&limit=20' next: type: string description: A URL to retrieve the next page of resources. example: '{apiPath}/v1/resource?offset=80&limit=20' previous: type: string description: A URL to retrieve the previous page of resources example: '{apiPath}/v1/resource?offset=40&limit=20' taskUrl: $ref: '#/components/schemas/TaskUrlSchema_OperatorListEndpoints' ParticipantSchemeMembershipResponseList_OperatorListEndpoints: title: ParticipantSchemeMembershipResponseList type: object properties: data: $ref: >- #/components/schemas/OffsetPaginatedListResponseParticipantSchemeMembership_OperatorListEndpoints links: $ref: '#/components/schemas/OffsetResponseLinksSchema_OperatorListEndpoints' ParticipantSchemeMembership_OperatorListEndpoints: title: ParticipantSchemeMembership required: - participantId - schemeCode - schemeMembershipId - schemeMembershipLastUpdatedOn - schemeMembershipStatusName - schemeName type: object properties: schemeMembershipId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id of a Scheme Membership assigned in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 schemeCode: type: string description: >- Code for the scheme (an abbreviated form) to which the participant is associated to. A participant can be associated to multiple schemes. Possible values can be fetched from "GET /filterValues?resourceName=schemes" endpoint. example: FSTP schemeName: type: string description: >- Name of the scheme to which the participant is associated to. A participant can be associated to multiple schemes. Possible values can be fetched from "GET /filterValues?resourceName=schemes" endpoint. example: Faster Payments schemeMembershipStatusName: type: string description: >- The status of the participant's membership within a specific scheme. When a Participant's Scheme Membership is suspended, transactions received for that Scheme are queued. Possible values can be fetched from "GET /filterValues?resourceName=schemeMembershipStatuses" endpoint. example: Active pendingSchemeAction: type: string description: >- The action that the Participant's Scheme Membership will move to once the scheme action effective date has been reached. The possible values for this are: "Onboarding" & "Offboarding". nullable: true example: Offboarding enum: - Onboarding - Offboarding schemeActionEffectiveDate: type: string description: >- The date and time at which the pending scheme action will be applied. This should follow the standard ISO 8601 format with UTC offset. format: date-time nullable: true example: '2022-09-28T13:00:00.123456Z' participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 schemeMembershipLastUpdatedOn: type: string description: >- Date and time at which the scheme membership was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-05-13T13:00:00.123456Z' TaskUrlSchema_OperatorListEndpoints: title: TaskLinks type: object properties: Task for Resource 1: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/581ddd74-5151-4c74-ad2f-b2196752bbad' Task for Resource 2: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/3d9397d1-e394-4863-be26-0686684bc510' APIErrorResponseDTO_OperatorListEndpoints: title: APIErrorResponse required: - detail - errors - id - status type: object properties: status: pattern: ^\d{3}$ type: string description: >- Standard HTTP Status code defined in RFC 7231 id: maxLength: 36 minLength: 36 type: string description: >- A unique reference (GUID) for the error instance, for audit purposes and traceability. format: uuid example: fb06dbc9-da8d-4927-b0f8-0eec823aaaa7 detail: type: string description: Brief error message explaining the error errors: type: array items: $ref: '#/components/schemas/ErrorsFragment_OperatorListEndpoints' APIErrorResponseWrapperDTO_OperatorListEndpoints: title: APIErrorResponseWrapper type: object properties: error: $ref: '#/components/schemas/APIErrorResponseDTO_OperatorListEndpoints' ErrorsFragment_OperatorListEndpoints: title: ErrorInfo required: - detail - errorCode type: object properties: errorCode: maxLength: 11 minLength: 11 pattern: E[A-Z0-9]{6}[0-9]{4} type: string description: |- Custom Error Code consists of the following example: EAPIGTW2039 detail: type: string description: Description of the error detail with further granularity uri: type: string description: >- URL to help remediate the problem, or provide more information, or to API Reference or help etc. format: uri FinancialAmount_OperatorListEndpoints: title: MonetaryDetail required: - currencyCode type: object properties: amount: maximum: 1e+33 exclusiveMaximum: true minimum: -1e+33 exclusiveMinimum: true type: number description: >- The number of monetary units specified in an active currency. This could be positive or negative amount. Negative amount should start with minus (-) sign. The amount format including decimal fraction should comply as per ISO 4217 currency amount. format: double nullable: true example: 50.65 currencyCode: pattern: ^[A-Z]{3}$ type: string description: >- Identification of the currency associated to the resource. This should follow the standard ISO 4217 format. Possible values can be fetched from "GET /filterValues?resourceName=currencies" endpoint. example: GBP description: >- The number of monetary units specified in an active currency. This could be positive or negative amount. Negative amount should start with minus (-) sign. The amount format including decimal fraction should comply as per ISO 4217 currency amount. nullable: true OffsetPaginatedListResponsePaymentParameter_OperatorListEndpoints: title: OffsetPaginatedListResponse type: object properties: results: type: array items: $ref: '#/components/schemas/PaymentParameter_OperatorListEndpoints' sort: type: string description: The sort direction and the field name used to sort the resources by. example: +id totalRecordCount: type: integer description: The total number of records for a given resource. format: int64 example: 100 offset: type: integer description: Current record count offset for this page. format: int64 example: 0 limit: type: integer description: The total number of records retrieved per page. format: int64 example: 20 PaymentParameterResponseList_OperatorListEndpoints: title: PaymentParameterResponseList type: object properties: data: $ref: >- #/components/schemas/OffsetPaginatedListResponsePaymentParameter_OperatorListEndpoints links: $ref: '#/components/schemas/OffsetResponseLinksSchema_OperatorListEndpoints' PaymentParameter_OperatorListEndpoints: title: PaymentParameter required: - bilateralBrakeValueCapId - bilateralBrakeValueCapLastUpdatedOn - bilateralLimitId - bilateralLimitLastUpdatedOn - bilateralPosition - counterPartyId - hasBilateralBrake - participantId - paymentParameterId type: object properties: paymentParameterId: pattern: >- ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}-[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the payment parameter assigned by the RTGS. ' example: >- a4faa192-ddd7-11ed-b5ea-0242ac120002-a4faa192-ddd7-11ed-b5ea-0242ac120003 participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120012 counterPartyId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the counter party in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120022 counterPartyShortName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,15}$ type: string description: 'Short Name of the CHAPS counter party participant in the RTGS. ' nullable: true example: BA03 counterPartyFullName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string description: 'Full Name of the CHAPS counter party participant in the RTGS. ' nullable: true example: Barclays Bank bilateralLimitId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the bilateral limit assigned by the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120032 bilateralLimit: type: array description: >- A limit set on a Participant's maximum net debit position against a single counter party. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' bilateralLimitLastUpdatedOn: type: string description: >- Date and time at which the bilateral limit was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-04-01T12:00:00.123456Z' bilateralPosition: type: array description: >- The sum of total settled CHAPS credits subtracted by the total settled CHAPS debits against the counter party for the value day in RTGS. This field supports up to 2 decimal places. items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' bilateralLimitPercentage: type: number description: >- A percentage which represents the ratio of the Bilateral Position to the bilateral limit. This shows what percentage of Bilateral Limit is available for the participant organisation. This field supports up to 2 decimal places. nullable: true example: 55.55 bilateralAmountAvailable: type: array description: >- Difference between the Bilateral Limit and the Bilateral Position. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' bilateralBrakeValueCapId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique Id for the bilateral brake value cap assigned by the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120042 bilateralValueCap: type: array description: >- A limit set on the maximum value for each funds transfer to a specific counter party. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' hasBilateralBrake: type: boolean description: >- Bilateral brake is used to pause the payments between the participant organisations. Flag to indicate whether bilateral brake is enabled or not for a specific counter party. If flag is "true", then bilateral brake is enabled. For authorised consumers, when performing an update, this is an editable field. example: false bilateralBrakeValueCapLastUpdatedOn: type: string description: >- Date and time at which the bilateral brake value cap was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-04-01T12:00:00.123456Z' queuedDebitsVolume: type: integer description: >- Number of queued debit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 10 queuedDebitsValue: type: array description: >- Sum of queued debit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' queuedCreditsVolume: type: integer description: >- Number of queued credit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 20 queuedCreditsValue: type: array description: >- Sum of queued credit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' settledDebitsVolume: type: integer description: >- Number of debit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 15 settledDebitsValue: type: array description: >- Sum of debit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' settledCreditsVolume: type: integer description: >- Number of credit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field does not support decimals. format: int32 nullable: true example: 25 settledCreditsValue: type: array description: >- Sum of credit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' transactionLastReceived: type: string description: >- Date and time at which the last transaction was received. This should follow the standard ISO 8601 format with UTC offset. format: date-time nullable: true example: '2022-04-01T12:00:00.123456Z' transactionLastSent: type: string description: >- Date and time at which the last transaction was sent. This should follow the standard ISO 8601 format with UTC offset. format: date-time nullable: true example: '2022-04-01T12:00:00.123456Z' readOnly: type: boolean description: >- Flag to indicate whether the resource is editable. If the flag is "true", the request to update/delete a resource will fail. nullable: true example: true ListResponseLinksSchema_ParticipantListEndpoints: title: Links required: - self type: object properties: self: type: string description: A URL to reproduce the current request. example: '{apiPath}/v1/resource' taskUrl: $ref: '#/components/schemas/TaskUrlSchema_ParticipantListEndpoints' ListResponseNotificationConfiguration_ParticipantListEndpoints: title: ListResponse type: object properties: results: type: array items: $ref: >- #/components/schemas/NotificationConfiguration_ParticipantListEndpoints NotificationConfigurationListResponse_ParticipantListEndpoints: title: NotificationConfigurationListResponse type: object properties: data: $ref: >- #/components/schemas/ListResponseNotificationConfiguration_ParticipantListEndpoints links: $ref: >- #/components/schemas/ListResponseLinksSchema_ParticipantListEndpoints NotificationConfiguration_ParticipantListEndpoints: title: NotificationConfiguration required: - lastUpdatedAt - notificationConfigurationId - notificationTypeCode - notificationTypeName - participantId - swiftIndicator - uiIndicator type: object properties: notificationConfigurationId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: >- A unique Id for the notification configuration assigned by the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120002 notificationTypeCode: pattern: ^([A-Z0-9]{1,11}|Task0001)$ type: string description: >- Unique code for the type of notification to which the notification preference is associated to in RTGS. example: NCSEINF0001 enum: - NCSEINF0001 - NCSEINF0002 - NCSEINF0025 - NCSEINF0026 - NCSEINF0020 - NCSEINF0017 notificationTypeName: pattern: ^[A-Za-z\s\/]{1,100}$ type: string description: >- Identifier of the type of notification to which the notification preference is associated to in RTGS. example: Window Open enum: - Window Open - Window Closed - Queue Blocked - Queue Unblocked - Account Report Failed - TAB Boundary Breached uiIndicator: type: boolean description: >- Flag to indicate whether or not a participant organisation will receive the notifications over UI. If set to "true", the UI notification preference will be Opt In and if set to "false", the UI notification preference will be Opt Out. For authorised consumers, when performing an update, this is an editable field. example: true swiftIndicator: type: boolean description: >- Flag to indicate whether or not a participant organisation will receive the notifications over SWIFT network. If set to "true", the SWIFT notification preference will be Opt In and if set to "false", the SWIFT notification preference will be Opt Out. For authorised consumers, when performing an update, this is an editable field. example: true lastUpdatedAt: type: string description: >- Date and time at which the notification configuration preference was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2021-05-22T13:00:00.123456Z' participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 readOnly: type: boolean description: >- Flag to indicate whether the resource is editable. If the flag is "true", the request to update/delete a resource will fail. nullable: true example: true TaskUrlSchema_ParticipantListEndpoints: title: TaskLinks type: object properties: Task for Resource 1: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/581ddd74-5151-4c74-ad2f-b2196752bbad' Task for Resource 2: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/3d9397d1-e394-4863-be26-0686684bc510' APIErrorResponseDTO_ParticipantListEndpoints: title: APIErrorResponse required: - detail - errors - id - status type: object properties: status: pattern: ^\d{3}$ type: string description: >- Standard HTTP Status code defined in RFC 7231 id: maxLength: 36 minLength: 36 type: string description: >- A unique reference (GUID) for the error instance, for audit purposes and traceability. format: uuid example: fb06dbc9-da8d-4927-b0f8-0eec823aaaa7 detail: type: string description: Brief error message explaining the error errors: type: array items: $ref: '#/components/schemas/ErrorsFragment_ParticipantListEndpoints' APIErrorResponseWrapperDTO_ParticipantListEndpoints: title: APIErrorResponseWrapper type: object properties: error: $ref: '#/components/schemas/APIErrorResponseDTO_ParticipantListEndpoints' ErrorsFragment_ParticipantListEndpoints: title: ErrorInfo required: - detail - errorCode type: object properties: errorCode: maxLength: 11 minLength: 11 pattern: E[A-Z0-9]{6}[0-9]{4} type: string description: |- Custom Error Code consists of the following example: EAPIGTW2039 detail: type: string description: Description of the error detail with further granularity uri: type: string description: >- URL to help remediate the problem, or provide more information, or to API Reference or help etc. format: uri CrestPaymentsBalanceSingleResponse_OperatorListEndpoints: title: CrestPaymentsBalanceSingleResponse type: object properties: data: $ref: >- #/components/schemas/SingleResponseCrestPaymentsBalance_OperatorListEndpoints links: $ref: '#/components/schemas/SingleResponseLinksSchema_OperatorListEndpoints' CrestPaymentsBalance_OperatorListEndpoints: title: CrestPaymentsBalance required: - participantId type: object properties: participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 participantFullName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string description: Full Name of the organisation / participants in the RTGS. nullable: true example: Barclays settlementAccountBalance: type: array description: >- Balance of the CREST settlement account. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' repoBalance: type: array description: >- Balance of the CREST repo account. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' crestSettlementLiquidityGroupBalance: type: array description: >- Total balances of all accounts in the CREST Settlement Liquidity Account Group. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' SingleResponseCrestPaymentsBalance_OperatorListEndpoints: title: SingleResponse type: object properties: results: type: array items: $ref: '#/components/schemas/CrestPaymentsBalance_OperatorListEndpoints' SingleResponseLinksSchema_OperatorListEndpoints: title: Links required: - self type: object properties: self: type: string description: A URL to reproduce the current request. example: '{apiPath}/v1/resource/1f740fe7-c251-4d82-8abd-11953d76f594' taskUrl: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/0e740fe7-c251-4d82-8abd-11953d76f593' SingleResponseLinksSchema_OperatorSingleEndpoints: title: Links required: - self type: object properties: self: type: string description: A URL to reproduce the current request. example: '{apiPath}/v1/resource/1f740fe7-c251-4d82-8abd-11953d76f594' taskUrl: type: string description: A URL to retrieve task information associated to a resource. example: '{taskApiPath}/v1/tasks/0e740fe7-c251-4d82-8abd-11953d76f593' APIErrorResponseDTO_OperatorSingleEndpoints: title: APIErrorResponse required: - detail - errors - id - status type: object properties: status: pattern: ^\d{3}$ type: string description: >- Standard HTTP Status code defined in RFC 7231 id: maxLength: 36 minLength: 36 type: string description: >- A unique reference (GUID) for the error instance, for audit purposes and traceability. format: uuid example: fb06dbc9-da8d-4927-b0f8-0eec823aaaa7 detail: type: string description: Brief error message explaining the error errors: type: array items: $ref: '#/components/schemas/ErrorsFragment_OperatorSingleEndpoints' APIErrorResponseWrapperDTO_OperatorSingleEndpoints: title: APIErrorResponseWrapper type: object properties: error: $ref: '#/components/schemas/APIErrorResponseDTO_OperatorSingleEndpoints' ErrorsFragment_OperatorSingleEndpoints: title: ErrorInfo required: - detail - errorCode type: object properties: errorCode: maxLength: 11 minLength: 11 pattern: E[A-Z0-9]{6}[0-9]{4} type: string description: |- Custom Error Code consists of the following example: EAPIGTW2039 detail: type: string description: Description of the error detail with further granularity uri: type: string description: >- URL to help remediate the problem, or provide more information, or to API Reference or help etc. format: uri ChapsPaymentsControlSingleResponse_OperatorSingleEndpoints: title: ChapsPaymentsControlSingleResponse type: object properties: data: $ref: >- #/components/schemas/SingleResponseChapsPaymentsControl_OperatorSingleEndpoints links: $ref: >- #/components/schemas/SingleResponseLinksSchema_OperatorSingleEndpoints ChapsPaymentsControl_OperatorSingleEndpoints: title: ChapsPaymentsControl required: - chapsPaymentsControlId - headroomBalance - headroomId - headroomLastUpdatedOn - headroomRefresh - maxHeadroom - multilateralLimitId - multilateralLimitLastUpdatedOn - multilateralValueCapId - multilateralValueCapLastUpdatedOn - participantId - settlementLiquidityGroupId type: object properties: chapsPaymentsControlId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: >- A unique ID for the chaps payments controls in the RTGS. This can be obtained from the "GET /participants/{participantId}/chapsPaymentsControls". example: a4faa192-ddd7-11ed-b5ea-0242ac120002 headroomId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: A unique Id for the headroom assigned by the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120012 headroomBalance: type: array description: >- The funds reserved in a settlement bank's account for a settlement request or non-CHAPS Transfer which is marked as Urgent. It will use Headroom first, then Non-Urgent Funds if there is insufficient Headroom. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. items: $ref: '#/components/schemas/FinancialAmount_OperatorSingleEndpoints' maxHeadroom: type: array description: >- The upper limit above which Headroom Balance may not exceed. This is set by a CHAPS Participant to help control the funds available to Non-Urgent Transactions. Cannot edit in conjunction with non-urgent balance and headroom refresh. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. items: $ref: '#/components/schemas/FinancialAmount_OperatorSingleEndpoints' headroomRefresh: type: string description: >- A Max Headroom value must be added to be able to turn on the Headroom Refresh. Max Headroom and Headroom Refresh, both can be updated as part of the same API call. When Headroom Refresh is turned on, a check will be made to identify whether there is a value in the Max Headroom field. When set to On, Headroom Balance is decreased by Urgent Debits and increased by all Credits up to an upper limit of Max Headroom. Where set to Off, Headroom Balance is decreased by Urgent Debits but not increased by any Credits. For authorised consumers, when performing an update, this is an editable field. example: 'On' enum: - 'On' - 'Off' headroomLastUpdatedOn: type: string description: >- Date and time at which the head room was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-12-02T13:00:00.123456Z' multilateralLimitId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: A unique Id for the multilateral limit assigned by the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120022 multilateralLimit: type: array description: >- A parameter which specifies the maximum value a CHAPS Participant is willing to send to all other CHAPS Participants in excess of value of transactions received. A transaction may not settle if the resulting Multilateral Position would exceed the Multilateral Limit. Can be zero, null, positive value. Zero - will block transaction from settling, they will remain queued. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/MultilateralLimit_OperatorSingleEndpoints' multilateralLimitLastUpdatedOn: type: string description: >- Date and time at which the multilateral limit was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-12-02T13:00:00.123456Z' multilateralPosition: type: array description: >- The sum of total settled CHAPS credits minus total settled CHAPS debits against all counter parties today. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorSingleEndpoints' multilateralValueCapId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: A unique Id for the multilateral value cap assigned by the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120032 multilateralValueCap: type: array description: >- The maximum transaction value that can be made by a CHAPS Participant to any counterparty. This overrides the bilateral value cap. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorSingleEndpoints' multilateralValueCapLastUpdatedOn: type: string description: >- Date and time at which the multilateral value cap was last updated. This should follow the standard ISO 8601 format with UTC offset. format: date-time example: '2022-12-02T13:00:00.123456Z' autoPromoteDelay: maximum: 9999 minimum: 0 type: integer description: >- The value in minutes. Participants can set this value to null or within the range of 0-9999 minutes. If the field is null, the transaction will not be promoted to urgent. If it is set to 0, the transaction will be promoted to urgent immediately. If the field is set to any other number between 1 to 9999, the number denotes the time in minutes before the transaction is promoted to urgent. For authorised consumers, when performing an update, this is an editable field. format: int32 nullable: true example: 60 nonUrgentBalance: type: array description: >- The funds available for settling Non-Urgent Payments. This value is derived from the SLG balance minus headroom Balance. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorSingleEndpoints' multilateralPositionPercentage: type: number description: >- A percentage which represents the ratio of the Multilateral Position to Multilateral Limit. This shows what percentage of multilateral limit is available for the participant organisation. This field supports up to 2 decimal places. nullable: true example: 100 settlementLiquidityGroupId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: >- A unique ID for the settlement liquidity group assigned by the RTGS. example: a4faa192-ddd7-11ed-b5ea-0242ac120002 participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 readOnly: type: boolean description: >- Flag to indicate whether the resource is editable. If the flag is "true", the request to update/delete a resource will fail. nullable: true example: true FinancialAmount_OperatorSingleEndpoints: title: MonetaryDetail required: - currencyCode type: object properties: amount: maximum: 1e+33 exclusiveMaximum: true minimum: -1e+33 exclusiveMinimum: true type: number description: >- The number of monetary units specified in an active currency. This could be positive or negative amount. Negative amount should start with minus (-) sign. The amount format including decimal fraction should comply as per ISO 4217 currency amount. format: double nullable: true example: 50.65 currencyCode: pattern: ^[A-Z]{3}$ type: string description: >- Identification of the currency associated to the resource. This should follow the standard ISO 4217 format. Possible values can be fetched from "GET /filterValues?resourceName=currencies" endpoint. example: GBP description: >- The number of monetary units specified in an active currency. This could be positive or negative amount. Negative amount should start with minus (-) sign. The amount format including decimal fraction should comply as per ISO 4217 currency amount. nullable: true MultilateralLimit_OperatorSingleEndpoints: title: MonetaryDetail required: - currencyCode type: object properties: amount: maximum: 1e+33 exclusiveMaximum: true minimum: 0 exclusiveMinimum: false type: number description: >- This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. format: double nullable: true example: 400000000.55 currencyCode: pattern: ^[A-Z]{3}$ type: string description: >- Identification of the currency associated to the resource. This should follow the standard ISO 4217 format. Possible values can be fetched from "GET /filterValues?resourceName=currencies" endpoint. example: GBP description: >- A parameter which specifies the maximum value a CHAPS Participant is willing to send to all other CHAPS Participants in excess of value of transactions received. A transaction may not settle if the resulting Multilateral Position would exceed the Multilateral Limit. Can be zero, null, positive value. Zero - will block transaction from settling, they will remain queued. This field supports up to 2 decimal places. For authorised consumers, when performing an update, this is an editable field. nullable: true SingleResponseChapsPaymentsControl_OperatorSingleEndpoints: title: SingleResponse type: object properties: results: type: array items: $ref: '#/components/schemas/ChapsPaymentsControl_OperatorSingleEndpoints' ChapsPaymentsBalancesSingleResponse_OperatorListEndpoints: title: ChapsPaymentsBalancesSingleResponse type: object properties: data: $ref: >- #/components/schemas/SingleResponseChapsPaymentsBalances_OperatorListEndpoints links: $ref: '#/components/schemas/SingleResponseLinksSchema_OperatorListEndpoints' ChapsPaymentsBalances_OperatorListEndpoints: title: ChapsPaymentsBalance required: - participantId type: object properties: participantId: pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ type: string description: 'A unique ID for the participant in the RTGS. ' example: a4faa192-ddd7-11ed-b5ea-0242ac120002 participantFullName: pattern: >- ^[\\0-9a-zA-Z\/\-\?\:\(\)\.\,\'\+\s\!\#\$\%\&\*\=\^\_\`\{\|\}~"\;\<\>\@\[\]]{1,100}$ type: string description: Full Name of the organisations / participants in the RTGS. nullable: true example: Barclays Bank schemeValueDayStatusCode: type: string description: 'The current processing status code of the scheme in RTGS. ' nullable: true example: OPEN enum: - OPEN - CLOSED - NONWORKING - OPENING - CLOSING - INTERBANK_ONLY - UNWINDING nextScheduledAt: type: string description: >- Scheduled start time of the next cycle of the Matching Process. This should follow the standard ISO 8601 format with UTC offset. format: date-time nullable: true example: '2021-02-22T12:00:00.123456Z' queuedDebitsVolume: type: integer description: >- Number of queued debit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field does not support decimals. nullable: true example: 11233 queuedDebitsValue: type: array description: >- Sum of queued debit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' queuedCreditsVolume: type: integer description: >- Number of queued credit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field does not support decimals. nullable: true example: 11233 queuedCreditsValue: type: array description: >- Sum of queued credit transactions in RTGS which have not yet settled for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' settledDebitsVolume: type: integer description: >- Number of debit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field does not support decimals. nullable: true example: 11233 settledDebitsValue: type: array description: >- Sum of debit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' settledCreditsVolume: type: integer description: >- Number of credit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field does not support decimals. nullable: true example: 11233 settledCreditsValue: type: array description: >- Sum of credit transactions successfully settled in RTGS for the value day. Can be zero, null, positive value. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' settlementAccountBalance: type: array description: >- The balance of the CHAPS Settlement Account in RTGS. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' liquidityAccountBalance: type: array description: >- Total balance of all liquidity accounts (excluding the CHAPS Settlement Account) in RTGS. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' settlementLiquidityGroupBalance: type: array description: >- Total balances of all balance allocations in the CHAPS settlement liquidity groups in RTGS. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' projectedSettlementLiquidityGroupBalance: type: array description: >- Calculated from settlement liquidity group balance + the queued credits - queued debit values. This amount assumes all queued transactions settle successfully. This field supports up to 2 decimal places. nullable: true items: $ref: '#/components/schemas/FinancialAmount_OperatorListEndpoints' SingleResponseChapsPaymentsBalances_OperatorListEndpoints: title: SingleResponse type: object properties: results: type: array items: $ref: '#/components/schemas/ChapsPaymentsBalances_OperatorListEndpoints' 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. * JWT-Bearer grant type [RFC 7523](https://tools.ietf.org/html/rfc7523) * Password grant type This API uses JWT-Bearer grant type. Please 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. In this declaration only the basic security element to transport the bearer token of an OAuth2 process is declared.securitySchemes: security: - oauthBearerToken: [ ]