openapi: 3.0.2 info: title: Trade Finance Undertaking API description: > Manage all processes involved in the life cycle of a Trade Finance Undertaking application between corporate and banks : `The API supports following functionalities:` * Request for application : Sent by the party requesting issuance of the undertaking (applicant or obligor) to the party issuing the undertaking (demand guarantee or standby letter of credit or dependent undertaking or counter-guarantee or counter-standby) and provides details on the applicable rules, terms, conditions and content of the undertaking to be issued. * Amendment of an already issued undertaking (reduction, release, extend, cancellation or termination) * Demand for payment or extension of undertaking expiry date `Error Responses` The API uses common HTTP status codes in the response header to indicate success or failure. Specific error code and description will be returned in the custom error schema. `Query Parameters` Each URL query parameter specifies an API query parameter that must be URL encoded. version: 0.0.1 tags: - name: Trade Finance Undertaking paths: /trade-finance-undertakings: get: tags: - Trade Finance Undertaking summary: Get Trade Finance Undertaking. description: > Request details of all avaiable Trade Finance Undertaking applications or issued Trade Finance Undertaking, including any amendments, demands, release, extensions. The endpoint will return an empty array when no resource is found. operationId: getBankGuarantees parameters: - name: X-Request-ID in: header description: >- Specify an unique end to end tracking request ID. The element will be populated by the Citi API gateway required: false style: simple explode: false schema: type: string x-requiredByAPIGateway: true x-requiredByServiceProvider: true - name: X-UserContext in: header description: >- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the Citi Identity Provider. This header is provided by the Citi API Gateway and is not required to be provided by the API consumer. required: false style: simple explode: false schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-e14JmCtQ - name: X-BIC in: header description: >- Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider. required: true style: simple explode: false schema: type: string example: CITIIE20 - name: applicant-issuance-request-identification in: query description: > Unique business reference of the Issuance Request, assigned by the applicant. Usage: The undertaking-identification must not be used in conjunction with any other filter criteria. The anticipation is that the value is unique to retrieve a specific application by the reference. required: false style: form explode: false schema: maxLength: 16 minLength: 1 type: string example: Corporateref1 - name: undertaking-identification in: query description: > Globally unique identification of the Trade Finance Undertaking application. The value must be constant throughout the lifecycle of the account. This identification shall be used as a unique reference to support application lifecycle to support interoperability between API and other channel. Usage: The undertaking-identification must not be used in conjunction with any other filter criteria. The anticipation is that the value is unique to retrieve a specific application by the reference. required: false style: form explode: false schema: maxLength: 16 minLength: 1 type: string example: '5000052001' - name: application-date in: query description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage: The application-date must not be used in conjunction with application-from-date or application-to-date or issuance-date. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string - name: application-from-date in: query description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage: The application-date must be used in conjunction with application-to-date. When used in conjunction with the application-to-date, the endpoint returns the application where the application date fall within that period. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string example: '2023-05-22' - name: application-to-date in: query description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage: The application-date must not be used in conjunction with application-from-date. When used in conjunction with the application-from-date, the endpoint returns the application where the application date fall within that period. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string example: '2023-05-23' - name: issuance-date in: query description: >- Date on which the Trade Finance Undertaking is issued by the issuing bank. Expressed in the YYYY-MM-DD format. The date cannot be in the future. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string - name: application-lifecycle-status in: query description: > Specifies the state of a Trade Finance Undertaking in its processing cycle. Type of Trade Finance Undertaking status, in a codified form * AMRQ - Trade Finance Undertaking Amendment Request * APPL - Trade Finance Undertaking Application required: false style: form explode: false schema: type: string example: APLA responses: '200': description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_200' examples: GETBankGuaranteeResponseCollectionEx-1: $ref: '#/components/examples/GETBankGuaranteeResponseCollectionEx-1' GETBankGuaranteeResponseCollectionEx-2: $ref: '#/components/examples/GETBankGuaranteeResponseCollectionEx-2' GETBankGuaranteeResponseCollectionEx-3: $ref: '#/components/examples/GETBankGuaranteeResponseCollectionEx-3' '400': description: Bad Request headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: Unauthorized headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '403': description: Forbidden headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '404': description: Not Found headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '406': description: Not Acceptable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '413': description: URI Too Long headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '415': description: Unsupported Media Type headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '429': description: Too Many Requests headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '500': description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '502': description: Bad Gateway headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '503': description: Service Unavailable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '504': description: Gateway Timeout headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' default: description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' post: tags: - Trade Finance Undertaking summary: Create Trade Finance Undertaking. description: >- Application for issuance of Trade Finance Undertaking. The request is sent by a corporate (Applicant) to its bank for bank review or as a final draft to issue a guarantee. operationId: createBankGuarantee parameters: - name: X-Request-ID in: header description: >- Specify an unique end to end tracking request ID. The element will be populated by the API gateway required: false style: simple explode: false schema: type: string x-requiredByAPIGateway: true x-requiredByServiceProvider: true - name: X-UserContext in: header description: >- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the Citi Identity Provider. This header is provided by the Citi API Gateway and is not required to be provided by the API consumer. required: false style: simple explode: false schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-e14JmCtQ - name: X-BIC in: header description: >- Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider. required: true style: simple explode: false schema: type: string example: CITIIE20 requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeFinanceInstruction' examples: CreateBankGuaranteeEx-1: $ref: '#/components/examples/CreateBankGuaranteeEx-1' CreateBankGuaranteeEx-2: $ref: '#/components/examples/CreateBankGuaranteeEx-2' CreateBankGuaranteeEx-3: $ref: '#/components/examples/CreateBankGuaranteeEx-3' CreateBankGuaranteeEx-4: $ref: '#/components/examples/CreateBankGuaranteeEx-4' required: true responses: '201': description: Created headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' '202': description: Accepted headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/TradeFinanceInstructionReference' example: application-reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 '400': description: Bad Request headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: Unauthorized headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '403': description: Forbidden headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '404': description: Not Found headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '406': description: Not Acceptable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '415': description: Unsupported Media Type headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '429': description: Too Many Requests headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '500': description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '502': description: Bad Gateway headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '503': description: Service Unavailable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '504': description: Gateway Timeout headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' default: description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' /trade-finance-undertakings/{application-reference}: get: tags: - Trade Finance Undertaking summary: Get Trade Finance Undertaking. description: >- Request details of a specific Trade Finance Undertaking application or issued Trade Finance Undertaking, including any amendments, demands, release, extensions etc. operationId: getBankGuarantee parameters: - name: X-Request-ID in: header description: >- Specify an unique end to end tracking request ID. The element will be populated by the API gateway required: false style: simple explode: false schema: type: string x-requiredByAPIGateway: true x-requiredByServiceProvider: true - name: X-UserContext in: header description: >- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the Identity Provider. This header is provided by the API Gateway and is not required to be provided by the API consumer. required: false style: simple explode: false schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-e14JmCtQ - name: X-BIC in: header description: >- Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider. required: true style: simple explode: false schema: type: string example: CITIIE20 - name: application-reference in: path description: > An unique and unambiguous identification of the Trade Finance Undertaking Application as assigned by the origin server. The value must be constant throughout the lifecycle of the application. On successful creation, the application can be retrieved using the application reference. This identification shall be used as a resource identifier for all state transition. required: true style: simple explode: false schema: type: string format: uuid example: 123e456-e89b-12d3-a456-426614174000 responses: '200': description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' ETag: $ref: '#/components/headers/ETag' content: application/json: schema: $ref: '#/components/schemas/TradeFinanceInstruction' examples: GETBankGuaranteeResponseEx-1: $ref: '#/components/examples/GETBankGuaranteeResponseEx-1' GETBankGuaranteeResponseEx-2: $ref: '#/components/examples/GETBankGuaranteeResponseEx-2' GETBankGuaranteeResponseEx-3: $ref: '#/components/examples/GETBankGuaranteeResponseEx-3' GETBankGuaranteeResponseEx-4: $ref: '#/components/examples/GETBankGuaranteeResponseEx-4' '400': description: Bad Request headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: Unauthorized headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '403': description: Forbidden headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '404': description: Not Found headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '406': description: Not Acceptable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '413': description: URI Too Long headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '415': description: Unsupported Media Type headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '429': description: Too Many Requests headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '500': description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '502': description: Bad Gateway headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '503': description: Service Unavailable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '504': description: Gateway Timeout headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' default: description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' patch: tags: - Trade Finance Undertaking summary: Update Trade Finance Undertaking. description: >- Post issuance amendments of the Trade Finance Undertaking including any permitted modification to the application such as reduction, release, extend. operationId: modifyBankGuarantee parameters: - name: X-Request-ID in: header description: >- Specify an unique end to end tracking request ID. The element will be populated by the API gateway required: false style: simple explode: false schema: type: string x-requiredByAPIGateway: true x-requiredByServiceProvider: true - name: X-UserContext in: header description: >- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the Identity Provider. This header is provided by the API Gateway and is not required to be provided by the API consumer. required: false style: simple explode: false schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-e14JmCtQ - name: X-BIC in: header description: >- Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider. required: true style: simple explode: false schema: type: string example: CITIIE20 - name: If-Match in: header description: >- This header will contain the Etag of the resource representation to be manipulate. If the server ETag value does not match with the provided ETag value, the error response 412 - precondition fail will be returned. This signifies the resource is out of date. required: false style: simple explode: false schema: type: string example: f88dd058fe004909615a64f01be66a7 - name: application-reference in: path description: > An unique and unambiguous identification of the Trade Finance Undertaking Application as assigned by the origin server. The value must be constant throughout the lifecycle of the application. On successful creation, the application can be retrieved using the application reference. This identification shall be used as a resource identifier for all state transition. required: true style: simple explode: false schema: type: string format: uuid example: 123e456-e89b-12d3-a456-426614174000 requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeFinanceInstruction' examples: updateBankGuarantee_success: $ref: '#/components/examples/UpdateBankGuarantee' required: true responses: '202': description: Accepted headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' '400': description: Bad Request headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: Unauthorized headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '403': description: Forbidden headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '404': description: Not Found headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '406': description: Not Acceptable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '412': description: Precondition Failed headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '415': description: Unsupported Media Type headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '429': description: Too Many Requests headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '500': description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '502': description: Bad Gateway headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '503': description: Service Unavailable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '504': description: Gateway Timeout headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' default: description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' components: schemas: AccountIdentificationChoice: title: AccountIdentification type: object additionalProperties: true description: >- Specifies the unique identification of an account as assigned by the account servicer. oneOf: - title: IBANAccountIdentification required: - iban type: object properties: iban: pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: > International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. x-MXComponent: IBAN2007Identifier x-Validation: true x-ValidationType: Algorithmic x-Error: >- ErrorCode:Sw.Stds.D00003, ErrorText:Invalid IBAN format or invalid check digits., CitiValidation:true, Severity:Fatal additionalProperties: false - title: OtherAccountIdentification required: - other type: object properties: other: maxLength: 34 minLength: 1 type: string description: >- Unique identification of an account, as assigned by the account servicer, using an identification scheme. additionalProperties: false Amount1Choice: x-MXComponent: Amount1Choice type: object description: Choice of amounts. additionalProperties: true oneOf: - type: object additionalProperties: false properties: increase_amount: x-MXComponent: ActiveCurrencyAndAmount description: > Amount of increase, and currency. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: object additionalProperties: false properties: currency: x-MXComponent: ActiveCurrencyCode type: string pattern: ^[A-Z]{3,3}$ amount: type: string maxLength: 19 pattern: >- ^0*(([0-9]{0,13}\.[0-9]{1,5})|([0-9]{0,14}\.[0-9]{1,4})|([0-9]{0,15}\.[0-9]{1,3})|([0-9]{0,16}\.[0-9]{1,2})|([0-9]{0,17}\.[0-9]{1,1})|([0-9]{0,18}\.)|0*|([0-9]{0,18}))$ required: - currency - amount required: - increase_amount - type: object additionalProperties: false properties: decrease_amount: x-MXComponent: ActiveCurrencyAndAmount description: > Amount of decrease, and currency. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: object additionalProperties: false properties: currency: x-MXComponent: ActiveCurrencyCode type: string pattern: ^[A-Z]{3,3}$ amount: type: string maxLength: 19 pattern: >- ^0*(([0-9]{0,13}\.[0-9]{1,5})|([0-9]{0,14}\.[0-9]{1,4})|([0-9]{0,15}\.[0-9]{1,3})|([0-9]{0,16}\.[0-9]{1,2})|([0-9]{0,17}\.[0-9]{1,1})|([0-9]{0,18}\.)|0*|([0-9]{0,18}))$ required: - currency - amount required: - decrease_amount BankGuaranteeAmendment2Subset: x-MXComponent: BankGuaranteeAmendment2Subset type: object description: Details of the bank guarantee amendment. additionalProperties: false properties: amendment_request_identification: x-MXComponent: RestrictedFINXMax16Text description: > Unique and unambiguous identifier assigned by the applicant to the Undertaking amendment request. MT Mapping: field 21A of MT 798 Specifies a character string with a maximum length of 16 characters. It has a pattern that disables the use of characters that is not part of the character set X, that is, that is not a-z A-Z / - ? : ( ) . , ‘ + , and disable the use of slash "/" at the beginning and end of line and double slash "//" within the line. type: string minLength: 1 maxLength: 16 pattern: >- ^([0-9a-zA-Z\-\?:\(\)\.,'\+ ]([0-9a-zA-Z\-\?:\(\)\.,'\+ ]*(/[0-9a-zA-Z\-\?:\(\)\.,'\+ ])?)*)$ amendment_platform_reference: x-MXComponent: UUIDv4Identifier description: > Unique technical reference assigned by the platform. Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". type: string pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ amendment_sequence_number: x-MXComponent: Max3NumericText description: > Sequence number assigned by the Applicant to each proposed Amendment of the Undertaking. MT Mapping: field 26E Specifies a numeric string with a maximum length of 3 digits. type: string pattern: ^[0-9]{1,3}$ amendment_request_date: x-MXComponent: ISODate description: > Date of the Undertaking amendment request. MT Mapping: field 13E A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. type: string pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ amendment_date: x-MXComponent: ISODate description: > Date on which the amendment is effective. MT Mapping: field 30 A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. type: string pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ undertaking_amendment_instruction_purpose: x-MXComponent: AmendmentPurpose1Code description: > Specifies the purpose of this instruction. MT Mapping: 22A Specifies whether the amendment is to be made to issued counter, counter-counter or local undertaking. Code Name Definition: *`ICCA` - AmendmentToIssuedCounterCounterUndertaking - Request issuance of amendment to issued counter counter-undertaking and/or request to issue amendment to counter-undertaking and local undertaking. *`ISCA` - AmendmentToIssuedCounterUndertaking - Request issuance of amendment to issued counter-undertaking and/or request to issue amendment to local undertaking. *`ISUA` - AmendmentToIssuedUndertaking - Request issuance of amendment to issued undertaking. type: string enum: - ICCA - ISCA - ISUA amendment_impact: type: array description: > Proposed amendment(s) to the undertaking in a codified form. Amendment to to a trade finance undertaking in a codified form. Code Name Definition: *`CTHR` - CounterUndertakingOtherAmendments - Any other amendments made to the undertaking. *`CUAD` - CounterUndertakingAmountDecrease - Indication of the amount of decrease to the undertaking amount. *`CUAI` - CounterUndertakingAmountIncrease - Indication of the amount of increase to the undertaking amount. *`CUDX` - CounterUndertakingExpiryDate - Specifies the new date when the undertaking will cease to be available. *`CUNB` - CounterUndertakingNewBeneficiary - Requested new beneficiary of the undertaking. *`CUTC` - CounterUndertakingTermsAndCondition - Requested new terms and conditions of the undertaking. *`CUXC` - CounterUndertakingNewExpiryCondition - Specifies the amended documentary condition that indicates when the undertaking will cease to be available. *`LTHR` - LocalUndertakingOtherAmendments - Any other amendments made to the local undertaking. *`LUAD` - LocalUndertakingAmountDecrease - Indication of the amount of decrease to the local undertaking amount. *`LUAI` - LocalUndertakingAmountIncrease - Indication of the amount of increase to the local undertaking amount. *`LUDX` - LocalUndertakingExpiryDate - Specifies the new date when the local undertaking will cease to be available. *`LUNB` - LocalUndertakingNewBeneficiary - Requested new beneficiary of the local undertaking. *`LUTC` - LocalUndertakingTermsAndCondition - Requested new terms and conditions of the local undertaking. *`LUXC` - LocalUndertakingNewExpiryCondition - Specifies the amended documentary condition that indicates when the local undertaking will cease to be available. items: x-MXComponent: AmendmentImpact1Code type: string enum: - CTHR - CUAD - CUAI - CUDX - CUNB - CUTC - CUXC - LTHR - LUAD - LUAI - LUDX - LUNB - LUTC - LUXC undertaking_termination_request: x-MXComponent: YesNoIndicator description: | Specifies that the instrument is requested to be cancelled. MT Mapping: 23S Indicates a "Yes" or "No" type of answer for an element. type: boolean undertaking_increase_decrease_amount: description: > Indication of the amount of increase or decrease to the undertaking amount. Choice of amounts. MT Mapping: field 32B/33B in SeqC $ref: '#/components/schemas/Amount1Choice' new_undertaking_terms_and_conditions: type: array maxItems: 8 description: > Specifies changes to the terms and conditions of the Undertaking (excluding information already expressed in other fields or other associated messages). MT Mapping: field 77U Specifies a character string with a maximum length of 9750 characters. items: x-MXComponent: Max9750Text type: string minLength: 1 maxLength: 9750 counter_undertaking_increase_decrease_amount: description: | Amount of increase, and currency. MT Mapping: field 32B/33B in SeqB $ref: '#/components/schemas/Amount1Choice' new_counter_undertaking_terms_and_condition: x-MXComponent: Max9750Text description: > Specifies changes to the terms and conditions of the local Undertaking (excluding information already expressed in other fields or other associated messages). MT Mapping: field 77L in SeqC Specifies a character string with a maximum length of 9750 characters. type: string minLength: 1 maxLength: 9750 delivery_channel_method: x-MXComponent: Max4Text description: Method by which the proposed amendment is to be made available. type: string minLength: 1 maxLength: 4 deliver_to_party_type: x-MXComponent: Max4Text description: "Type of party to whom the proposed amendment is intended to be delivered.\n\nType of party can be either \n- a code from the list published on ISO20022.org as part of external code sets\nOR\n- if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used\n\n\"\nCode\"\t\"\nName\"\nADVP - AdvisingParty\nANYB - AnyBank\nAPPL - Applicant\nBENE - Beneficiary\nCONF - ConfirmationParty\nCUB2 - SecondCounterUndertakingBeneficiary\nCUB3 - ThirdCounterUndertakingBeneficiary\nISSU - Issuer\nOBLG - Obligor\nORDR - OrderingParty\nPRES - PresentingParty\nSADV - SecondAdvisingParty\nSPEC - SpecifiedAddress\n\n\nMT Mapping: field 24G\n\nSpecifies a character string with a maximum length of 4 characters.\n" type: string minLength: 1 maxLength: 4 deliver_to_name: x-MXComponent: RestrictedFINXMax140Text description: > Name of party to whom the proposed amendment is intended to be delivered. MT Mapping: field 24G Specifies a character string with a maximum length of 140 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + . type: string minLength: 1 maxLength: 140 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.\n\r,'\+ ]{1,140}$ deliver_to_address: type: array maxItems: 3 description: > Address of party to whom the original undertaking or proposed amendment is intended to be delivered. MT Mapping: field 24G Specifies a character string with a maximum length of 35 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + . items: x-MXComponent: RestrictedFINXMax35Text type: string minLength: 1 maxLength: 35 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.,'\+ ]{1,35}$ deliver_to_tracking_reference: x-MXComponent: Max35Text description: > Unique tracking reference used by the delivery method, for example courier tracking reference, FileAct reference, etc. Specifies a character string with a maximum length of 35 characters. type: string minLength: 1 maxLength: 35 additional_deliver_to_details: x-MXComponent: RestrictedFINMax35Text description: > Additional information related to 'Deliver to' information. Usage Guideline: This field can additionally be used to identify the format and channel when the format and channel code is 'OTHR'. Recommend to structure the information as follows (example): When Format is Other - //OTHR//JPEG When Channel is Other - //OTHR//HOST When both Format and Channel is Other - //OTHR//JPEG//OTHR//HOST Specifies a character string with a maximum length of 35 characters. It has a pattern ([^/]+/)+([^/]+)|([^/]*) that disables the use of slash "/" at the beginning and end of line and double slash "//" within the line. type: string minLength: 1 maxLength: 35 pattern: ^([^/]+/)+([^/]+)|([^/]*)$ reduction_release: description: | Not Applicable supporting_document: type: array description: | Not Applicable additional_information: x-MXComponent: Max210Text description: > Additional information related to the amendment or release/reduction of the undertaking. MT Mapping: field 72Z Specifies a character string with a maximum length of 210 characters. type: string minLength: 1 maxLength: 210 BankGuaranteeAmendment3Subset: required: - amendment_sequence_number - amendment_request_identification x-MXComponent: BankGuaranteeAmendment3Subset type: object description: Details of the bank guarantee amendment. additionalProperties: false properties: amendment_request_identification: x-MXComponent: RestrictedFINXMax16Text description: > Unique and unambiguous identifier assigned by the applicant to the Undertaking amendment request. MT Mapping: field 21A of MT 798 Specifies a character string with a maximum length of 16 characters. It has a pattern that disables the use of characters that is not part of the character set X, that is, that is not a-z A-Z / - ? : ( ) . , ‘ + , and disable the use of slash "/" at the beginning and end of line and double slash "//" within the line. type: string minLength: 1 maxLength: 16 pattern: >- ^([0-9a-zA-Z\-\?:\(\)\.,'\+ ]([0-9a-zA-Z\-\?:\(\)\.,'\+ ]*(/[0-9a-zA-Z\-\?:\(\)\.,'\+ ])?)*)$ amendment_platform_reference: x-MXComponent: UUIDv4Identifier description: > Unique technical reference assigned by the platform. Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". type: string pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ amendment_sequence_number: x-MXComponent: Max3NumericText description: > Sequence number assigned by the Applicant to each proposed Amendment of the Undertaking. MT Mapping: field 26E Specifies a numeric string with a maximum length of 3 digits. type: string pattern: ^[0-9]{1,3}$ amendment_request_date: x-MXComponent: ISODate description: > Date of the Undertaking amendment request. MT Mapping: field 13E A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. type: string pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ amendment_date: x-MXComponent: ISODate description: > Date on which the amendment is effective. MT Mapping: field 30 A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. type: string pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ undertaking_amendment_instruction_purpose: x-MXComponent: AmendmentPurpose1Code description: > Specifies the purpose of this instruction. MT Mapping: 22A Specifies whether the amendment is to be made to issued counter, counter-counter or local undertaking. Code Name Definition: *`ICCA` - AmendmentToIssuedCounterCounterUndertaking - Request issuance of amendment to issued counter counter-undertaking and/or request to issue amendment to counter-undertaking and local undertaking. *`ISCA` - AmendmentToIssuedCounterUndertaking - Request issuance of amendment to issued counter-undertaking and/or request to issue amendment to local undertaking. *`ISUA` - AmendmentToIssuedUndertaking - Request issuance of amendment to issued undertaking. type: string enum: - ICCA - ISCA - ISUA amendment_impact: type: array description: > Proposed amendment(s) to the undertaking in a codified form. Amendment to to a trade finance undertaking in a codified form. Code Name Definition: *`CTHR` - CounterUndertakingOtherAmendments - Any other amendments made to the undertaking. *`CUAD` - CounterUndertakingAmountDecrease - Indication of the amount of decrease to the undertaking amount. *`CUAI` - CounterUndertakingAmountIncrease - Indication of the amount of increase to the undertaking amount. *`CUDX` - CounterUndertakingExpiryDate - Specifies the new date when the undertaking will cease to be available. *`CUNB` - CounterUndertakingNewBeneficiary - Requested new beneficiary of the undertaking. *`CUTC` - CounterUndertakingTermsAndCondition - Requested new terms and conditions of the undertaking. *`CUXC` - CounterUndertakingNewExpiryCondition - Specifies the amended documentary condition that indicates when the undertaking will cease to be available. *`LTHR` - LocalUndertakingOtherAmendments - Any other amendments made to the local undertaking. *`LUAD` - LocalUndertakingAmountDecrease - Indication of the amount of decrease to the local undertaking amount. *`LUAI` - LocalUndertakingAmountIncrease - Indication of the amount of increase to the local undertaking amount. *`LUDX` - LocalUndertakingExpiryDate - Specifies the new date when the local undertaking will cease to be available. *`LUNB` - LocalUndertakingNewBeneficiary - Requested new beneficiary of the local undertaking. *`LUTC` - LocalUndertakingTermsAndCondition - Requested new terms and conditions of the local undertaking. *`LUXC` - LocalUndertakingNewExpiryCondition - Specifies the amended documentary condition that indicates when the local undertaking will cease to be available. items: x-MXComponent: AmendmentImpact1Code type: string enum: - CTHR - CUAD - CUAI - CUDX - CUNB - CUTC - CUXC - LTHR - LUAD - LUAI - LUDX - LUNB - LUTC - LUXC undertaking_termination_request: x-MXComponent: YesNoIndicator description: | Specifies that the instrument is requested to be cancelled. MT Mapping: 23S Indicates a "Yes" or "No" type of answer for an element. type: boolean undertaking_increase_decrease_amount: description: > Indication of the amount of increase or decrease to the undertaking amount. Choice of amounts. MT Mapping: field 32B/33B in SeqC $ref: '#/components/schemas/Amount1Choice' new_undertaking_terms_and_conditions: type: array maxItems: 8 description: > Specifies changes to the terms and conditions of the Undertaking (excluding information already expressed in other fields or other associated messages). MT Mapping: field 77U Specifies a character string with a maximum length of 9750 characters. items: x-MXComponent: Max9750Text type: string minLength: 1 maxLength: 9750 counter_undertaking_increase_decrease_amount: description: | Amount of increase, and currency. MT Mapping: field 32B/33B in SeqB $ref: '#/components/schemas/Amount1Choice' new_counter_undertaking_terms_and_condition: x-MXComponent: Max9750Text description: > Specifies changes to the terms and conditions of the local Undertaking (excluding information already expressed in other fields or other associated messages). MT Mapping: field 77L in SeqC Specifies a character string with a maximum length of 9750 characters. type: string minLength: 1 maxLength: 9750 delivery_channel_method: x-MXComponent: Max4Text description: Method by which the proposed amendment is to be made available. type: string minLength: 1 maxLength: 4 deliver_to_party_type: x-MXComponent: Max4Text description: "Type of party to whom the proposed amendment is intended to be delivered.\n\nType of party can be either \n- a code from the list published on ISO20022.org as part of external code sets\nOR\n- if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used\n\n\"\nCode\"\t\"\nName\"\nADVP - AdvisingParty\nANYB - AnyBank\nAPPL - Applicant\nBENE - Beneficiary\nCONF - ConfirmationParty\nCUB2 - SecondCounterUndertakingBeneficiary\nCUB3 - ThirdCounterUndertakingBeneficiary\nISSU - Issuer\nOBLG - Obligor\nORDR - OrderingParty\nPRES - PresentingParty\nSADV - SecondAdvisingParty\nSPEC - SpecifiedAddress\n\n\nMT Mapping: field 24G\n\nSpecifies a character string with a maximum length of 4 characters.\n" type: string minLength: 1 maxLength: 4 deliver_to_name: x-MXComponent: RestrictedFINXMax140Text description: > Name of party to whom the proposed amendment is intended to be delivered. MT Mapping: field 24G Specifies a character string with a maximum length of 140 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + . type: string minLength: 1 maxLength: 140 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.\n\r,'\+ ]{1,140}$ deliver_to_address: type: array maxItems: 3 description: > Address of party to whom the original undertaking or proposed amendment is intended to be delivered. MT Mapping: field 24G Specifies a character string with a maximum length of 35 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + . items: x-MXComponent: RestrictedFINXMax35Text type: string minLength: 1 maxLength: 35 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.,'\+ ]{1,35}$ deliver_to_tracking_reference: x-MXComponent: Max35Text description: > Unique tracking reference used by the delivery method, for example courier tracking reference, FileAct reference, etc. Specifies a character string with a maximum length of 35 characters. type: string minLength: 1 maxLength: 35 additional_deliver_to_details: x-MXComponent: RestrictedFINMax35Text description: > Additional information related to 'Deliver to' information. Usage Guideline: This field can additionally be used to identify the format and channel when the format and channel code is 'OTHR'. Recommend to structure the information as follows (example): When Format is Other - //OTHR//JPEG When Channel is Other - //OTHR//HOST When both Format and Channel is Other - //OTHR//JPEG//OTHR//HOST Specifies a character string with a maximum length of 35 characters. It has a pattern ([^/]+/)+([^/]+)|([^/]*) that disables the use of slash "/" at the beginning and end of line and double slash "//" within the line. type: string minLength: 1 maxLength: 35 pattern: ^([^/]+/)+([^/]+)|([^/]*)$ reduction_release: description: | Not Applicable supporting_document: type: array description: | Not Applicable additional_information: x-MXComponent: Max210Text description: > Additional information related to the amendment or release/reduction of the undertaking. MT Mapping: field 72Z Specifies a character string with a maximum length of 210 characters. type: string minLength: 1 maxLength: 210 ActiveCurrencyAndAmount: required: - amount - currency type: object properties: currency: pattern: ^[A-Z]{3,3}$ type: string description: | Not Applicable. x-MXComponent: ActiveOrHistoricCurrencyCode x-Validation: true x-ValidationType: Algorithmic, ReferenceData x-Error: >- ErrorCode:Sw.Stds.D00006, ErrorText:Invalid currency code., :true, Severity:Fatal amount: maxLength: 19 pattern: >- ^0*(([0-9]{0,13}\.[0-9]{1,5})|([0-9]{0,14}\.[0-9]{1,4})|([0-9]{0,15}\.[0-9]{1,3})|([0-9]{0,16}\.[0-9]{1,2})|([0-9]{0,17}\.[0-9]{1,1})|([0-9]{0,18}\.)|0*|([0-9]{0,18}))$ type: string description: > The amount with fractional digit. Note: The decimal separator is a dot. Usage: Total digits: 18 Fraction Digits: 5 x-MXComponent: ActiveCurrencyAndAmount x-Validation: true x-ValidationType: Algorithmic x-Error: >- ErrorCode:Sw.Stds.D00007, ErrorText:Too many decimal digits or the amount does not comply with the pattern. Severity:Fatal additionalProperties: false description: >- A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. AmendmentPurposeTypeCode: type: string description: > Purpose of amendment message Code Name Definition: * ICCA - Request issuance of amendment to issued counter counter-undertaking and/or request to issue amendment to counter-undertaking and local undertaking. * ISCA - Request issuance of amendment to issued counter-undertaking and/or request to issue amendment to local undertaking. * ISUA - Request issuance of amendment to issued undertaking. Usage -> This field is applicable for Amend of Bank Guarantee. enum: - ICCA - ISCA - ISUA AmountChoice: title: AmountChoice type: object additionalProperties: true description: | Choice of amounts. Usage -> This field is applicable for Amend of Bank Guarantee. oneOf: - title: AmountIncrease required: - increase_amount type: object properties: increase_amount: $ref: '#/components/schemas/ActiveCurrencyAndAmount' additionalProperties: false - title: AmountDecrease required: - decrease_amount type: object properties: decrease_amount: $ref: '#/components/schemas/ActiveCurrencyAndAmount' additionalProperties: false AnyBICDec2014Identifier: pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ type: string description: >- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)". AutoExtendChoice: title: AutoExtend type: object additionalProperties: true description: > Choice of format for the auto extend period.This field will be available only expriy type is COND. Usage : It is applicable for Issuance and Amendment of Bank Guarantee oneOf: - title: AutoExtendDays required: - days type: object properties: days: type: integer description: Number of days. format: int32 additionalProperties: false - title: AutoExtendMonths required: - months type: object properties: months: type: integer description: Number of months. format: int32 additionalProperties: false - title: AutoExtendYears required: - years type: object properties: years: type: integer description: Number of years. format: int32 additionalProperties: false - title: AutoExtendDate required: - date type: object properties: date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: Auto extension end date. x-MXComponent: ISODate additionalProperties: false BranchAndFinancialInstitutionIdentification: required: - financial_institution_identification type: object properties: financial_institution_identification: $ref: '#/components/schemas/FinancialInstitutionIdentification' branch_identification: $ref: '#/components/schemas/BranchIdentification' additionalProperties: false description: >- Unique and unambiguous identification of a financial institution or a branch of a financial institution. BranchIdentification: type: object properties: identification: maxLength: 35 minLength: 1 type: string description: >- Unique and unambiguous identification of a branch of a financial institution. lei: pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ type: string description: >- Legal entity identification for the branch of the financial institution. x-MXComponent: LEIIdentifier name: maxLength: 35 minLength: 1 type: string description: >- Name by which an agent is known and which is usually used to identify that agent. address_line: maxItems: 3 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. It is recommended to use dedicated elements like TownName, CountrySubDivision, PostCode, Country etc. as much as possible. MT Mapping: Address from fields 50, 51, 52a, 59a, 56a, 57a. items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text additionalProperties: false description: >- Information that locates and identifies a specific branch of a financial institution. CashAccount: required: - currency - identification type: object properties: identification: $ref: '#/components/schemas/AccountIdentificationChoice' type: $ref: '#/components/schemas/CashAccountTypeChoice' currency: pattern: ^[A-Z]{3,3}$ type: string description: > Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account. x-MXComponent: ActiveOrHistoricCurrencyCode name: maxLength: 70 minLength: 1 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.,'\+ ]+$ type: string description: > Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number. alternate_identification: $ref: '#/components/schemas/GenericIdentification' owner: $ref: '#/components/schemas/PartyIdentification' servicer: $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' additionalProperties: false description: Provides the details to identify an account. CashAccountTypeChoice: title: CashAccountType type: object additionalProperties: true description: Nature or use of the account. oneOf: - title: CashAccountTypeCode required: - code type: object properties: code: maxLength: 4 minLength: 1 type: string description: >- Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. x-MXComponent: ExternalCashAccountTypeCode additionalProperties: false - title: CashAccountTypeProprietary required: - proprietary type: object properties: proprietary: maxLength: 35 minLength: 1 type: string description: Nature or use of the account in a proprietary form. additionalProperties: false Charge: type: object properties: charge_type: maxLength: 8 minLength: 4 type: string description: > This field contains information about the type of charges. One or more of the following codes may be used. Code Name Definition: * AGENT - Agent's Commission * COMM - Our Commission * CORCOM - Our Correspondent's Commission * DISC - Commercial Discount * INSUR - Insurance Premium * POST - Our Postage * STAMP - Stamp Duty * TELECHAR - Teletransmission Charges * WAREHOUS - Wharfing and Warehouse MT Mapping - field 71D charges_payable_by: maxLength: 4 minLength: 4 type: string description: > Indicates whether the applicant/obligor or beneficiary is responsible for payment of the charges. Code Name Definition: * ADVP - AdvisingParty * ANYB - AnyBank * APPL - Applicant * BENE - Beneficiary * CONF - ConfirmationParty * CUB2 - SecondCounterUndertakingBeneficiary * CUB3 - ThirdCounterUndertakingBeneficiary * ISSU - Issuer * OBLG - Obligor * ORDR - OrderingParty * PRES - PresentingParty * SADV - SecondAdvisingParty * SPEC - SpecifiedAddress If code is different from the above code list, then a bilaterally agreed code may be used. MT Mapping: field 71D" charges_account: $ref: '#/components/schemas/AccountIdentificationChoice' charge_amount: $ref: '#/components/schemas/ActiveCurrencyAndAmount' additionalProperties: false description: Charges applied ClearingSystemIdentificationChoice: title: ClearingSystemIdentification type: object additionalProperties: true description: Choice of a clearing system identifier. oneOf: - title: ClearingSystemIdentificationCode required: - code type: object properties: code: maxLength: 5 minLength: 1 type: string description: >- Identification of a clearing system, in a coded form as published in an external list. External code sets can be downloaded from www.iso20022.org. x-MXComponent: ExternalClearingSystemIdentificationCode additionalProperties: false - title: ClearingSystemIdentificationProperties required: - proprietary type: object properties: proprietary: maxLength: 35 minLength: 1 type: string description: >- Identification code for a clearing system, that has not yet been identified in the list of clearing systems. additionalProperties: false ClearingSystemMemberIdentification: required: - member_identification type: object properties: clearing_system_identification: $ref: '#/components/schemas/ClearingSystemIdentificationChoice' member_identification: maxLength: 35 minLength: 1 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.,'\+ ]+$ type: string description: Identification of a member of a clearing system. additionalProperties: false description: >- Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system. CompleteDemandCode: maxLength: 4 minLength: 4 type: string description: > The codes specify whether the demand is complete or incomplete. Code Name Definition: * COMP - Complete demand, no other documentation to accompany or follow this message. * INCP - Incomplete demand, supporting documentation to be presented separately. enum: - COMP - INCP Contacts: type: object properties: name: maxLength: 35 minLength: 1 type: string description: >- Name by which a party is known and which is usually used to identify that party. x-MTComponent: RestrictedFINXMax35Text phone_number: $ref: '#/components/schemas/PhoneNumber' email_address: type: string description: Address for electronic mail (e-mail). format: email additionalProperties: false description: Address for electronic mail (e-mail). CountryCode: pattern: ^[A-Z]{2,2}$ type: string description: >- Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). x-Validation: true x-ValidationType: Algorithmic, ReferenceData x-Error: >- ErrorCode:Sw.Stds.D00004, ErrorText:Invalid Country Code. Severity:Fatal DateAndPlaceOfBirth: required: - birth_date - city_of_birth - country_of_birth type: object properties: birth_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: Date on which a person is born. x-MXComponent: ISODate province_of_birth: maxLength: 35 minLength: 1 type: string description: Province where a person was born. city_of_birth: maxLength: 35 minLength: 1 type: string description: City where a person was born. country_of_birth: $ref: '#/components/schemas/CountryCode' additionalProperties: false description: Date and place of birth of a person. DemandCode: maxLength: 4 minLength: 4 type: string description: | Code for partial and/or multiple demands. Code Name Definition: * NMLT -Multiple demands not permitted. * NMPT -Multiple and partial demands not permitted. * NPRT`-Partial demands not permitted. Usage : - It is applicable for Issuance of Bank Guarantee. enum: - NMLT - NMPT - NPRT DemandTypeCode: maxLength: 4 minLength: 4 type: string description: | Specifies the type of demand for payment. Code Name Definition: * PAYM - Pay only. * PAEX- Pay or extend. enum: - PAYM - PAEX DocumentSummary: type: object properties: wording: maxLength: 6500 minLength: 1 type: string description: 'Wording for document. MT Mapping: Field 45C & Field 22Y' electronic_details: type: array description: >- Details related to an electronic presentation. MT Mapping: field 45C items: $ref: '#/components/schemas/Presentation' file_name: maxLength: 140 minLength: 1 type: string description: 'Specifies the name of the file. MT Mapping: field 23X' additionalProperties: false description: Information about a document. Document: required: - undertaking_document_identification - undertaking_document_type type: object properties: undertaking_document_type: maxLength: 4 minLength: 4 type: string description: | Type of document or template. Code Name Definition: * BENS - BeneficiaryStatement * CINV - CommercialInvoice * CLAF - ClaimForm * DEMD - Demand * ECID - E-stamp Certificate ID * OTH - Other * TRAF - TransferForm Or any other bilaterally agreed code. MT Mapping: field 23X" undertaking_document_identification: maxLength: 35 minLength: 1 type: string description: 'Identification of the document or template. MT Mapping: field 23X' undertaking_document_format: type: string description: | Format of the document or template, such as PDF, XML, XSLT. Code Name Definition: * DPDF - PDF * DXML - XML * SDSH - Spreadsheet * WORD - Word * XSLT - XSLT Or any other bilaterally agreed code. file_name: maxLength: 140 minLength: 1 type: string description: 'Name of the file. MT Mapping: field 23X' issue_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Specifies the issue date or date the document. A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. x-MXComponent: ISODate linked_url_address: maxLength: 256 minLength: 1 type: string description: >- Address for the Universal Resource Locator (URL), eg, used over the www (HTTP) service. format: uri digital_signature: $ref: '#/components/schemas/PartyAndSignature' additional_details: maxLength: 35 minLength: 1 type: string description: | Additional information related to the supporting document. additionalProperties: false description: Information about a document. ExpiryTypeCode: maxLength: 4 minLength: 4 type: string description: > This field specifies whether the undertaking has a specified expiry date or is open-ended or is dependent non a documentary condition or event. Code Name Definition: * COND - Expiry condition (including option for specified date of expiry). * FIXD - Specified date of expiry (either with or without automatic extension). * OPEN - No specified date of expiry. Usage :- it is applicable for Issuance and Amendment Bank of Guarantee. enum: - COND - FIXD - OPEN FinancialInstitutionIdentification: type: object properties: bicfi: pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ type: string description: > Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)". x-MXComponent: BICFIDec2014Identifier x-Validation: true x-ValidationType: Algorithmic x-Error: ErrorCode:Sw.Stds.D00008, ErrorText:Invalid BIC., Severity:Fatal clearing_system_member_identification: $ref: '#/components/schemas/ClearingSystemMemberIdentification' lei: pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ type: string description: Legal entity identifier of the financial institution. x-MXComponent: LEIIdentifier name: maxLength: 140 minLength: 1 pattern: ^[0-9a-zA-Z/\-\?:\(\)\.,'\+ !#$%&\*=^_`\{\|\}~";<>@\[\\\]]+$ type: string description: >- Name by which an agent is known and which is usually used to identify that agent. address_line: maxItems: 3 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. It is recommended to use dedicated elements like TownName, CountrySubDivision, PostCode, Country etc. as much as possible. MT Mapping: Address from fields 50, 51, 52a, 59a, 56a, 57a. items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text country: $ref: '#/components/schemas/CountryCode' other: $ref: '#/components/schemas/GenericIdentification' additionalProperties: false description: Specifies the details to identify a financial institution. FormOfUndertakingCode: maxLength: 4 minLength: 4 type: string description: > This field specifies the form of the independent and irrevocable undertaking.Code Name Definition: * DGAR - Demand guarantee * STBY - Standby letter of credit. Usage : This field is applicable only for Iussance of Bank Guarantee enum: - DGAR - STBY GenericIdentification: required: - identification type: object properties: identification: maxLength: 36 minLength: 1 type: string description: >- Proprietary information, often a code, issued by the data source scheme issuer. scheme_name: maxLength: 35 minLength: 1 type: string description: Short textual description of the scheme. issuer: maxLength: 35 minLength: 1 type: string description: Entity that assigns the identification. additionalProperties: false description: >- Information related to an identification, for example, party identification or account identification. GenericOrganisationIdentification: required: - identification type: object properties: identification: maxLength: 35 minLength: 1 type: string description: Identification assigned by an institution. scheme_name: $ref: '#/components/schemas/OrganisationIdentificationSchemeNameChoice' issuer: maxLength: 35 minLength: 1 type: string description: Entity that assigns the identification. additionalProperties: false description: Information related to an identification of an organisation. GenericPersonIdentification: required: - identification type: object properties: identification: maxLength: 35 minLength: 1 type: string description: Unique and unambiguous identification of a person. scheme_name: $ref: '#/components/schemas/PersonIdentificationSchemeNameChoice' issuer: maxLength: 35 minLength: 1 type: string description: Entity that assigns the identification. additionalProperties: false description: Information related to an identification of a person. GovernanceIdentificationCode: maxLength: 4 minLength: 4 type: string description: > Specifies the identification of the rules and laws governing the undertaking. Code Name Definition: * ISPR - The version of the International Standby Practices (ISP) that is in effect on the date of issue of the undertaking. * NONE - No applicable rule set defined. * OTHR - The undertaking is subject to another set of rules, or the undertaking is not subject to the version of the rules that is in effect on the date of issue, these must be specified in GovernanceRuleNarrative. * UCPR - The version of the Uniform Customs and Practice for Documentary Credits (UCP) as published by the International Chamber of Commerce (ICC) that is in effect on the date of issue of the undertaking. * URDG - The version of the ICC Uniform Rules For Demand Guarantees (URDG) as published by the International Chamber of Commerce (ICC) that is in effect on the date of issue of the undertaking. Usage : - It is applicable for Issuance of Bank Guarantee enum: - ISPR - NONE - OTHR - UCPR - URDG GuaranteePaymentDemand: required: - complete_indicator - demand_amount - demand_submission_date - demand_type - party - undertaking_identification type: object properties: undertaking_identification: maxLength: 16 minLength: 1 type: string description: >- Business identification of the undertaking. Filled in by the bank after issuance of the Trade Finance Undertaking, stays unique throughout the lifecycle of the guarantee. MT Mapping: field 20 x-MTComponent: RestrictedFINXMax16Text advising_party_reference_number: maxLength: 16 minLength: 1 type: string description: >- Unique and unambiguous identifier assigned by the advising party to the undertaking. MT Mapping: field 21 x-MTComponent: RestrictedFINMax16Text beneficiary_reference_number: maxLength: 16 minLength: 1 type: string description: >- Unique and unambiguous identifier assigned by the beneficiary to the undertaking. MT Mapping: field 23 x-MTComponent: RestrictedFINXMax16Text demand_type: $ref: '#/components/schemas/DemandTypeCode' demand_submission_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: 'Date at which the demand is submitted. MT Mapping: field 31L.' x-MXComponent: ISODate demand_amount: $ref: '#/components/schemas/ActiveCurrencyAndAmount' demand_amount_additional_information: maxLength: 780 minLength: 1 type: string description: >- Additional information concerning the demand amount. MT Mapping: field 78 party: type: array description: | Parties specified in the undertaking or related to the Undertaking. The type of Party is specified in the first element, Type. Usage Rule: MANDATORY to include one iteration each of Party for 1. Beneficiary 2. Advising/nominated/confirming bank 3. Applicant 4. Issuing bank optionally for other parties. MT Mapping: 52a, 59a, 56a, 57a items: $ref: '#/components/schemas/PartyIdentificationDetail' requested_expiry_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Requested new expiry date as an alternative to payment of the demand. Rule: Requested expiry date must be present when demand type is Pay or Extend. MT Mapping: field 31E x-MXComponent: ISODate complete_indicator: $ref: '#/components/schemas/CompleteDemandCode' completion_information: maxLength: 3250 minLength: 1 type: string description: >- Information related to an incomplete presentation. MT Mapping: field 49A presentation_completion_details: maxLength: 700 minLength: 1 type: string description: >- This field specifies information about the presentation documentation. If the presentation is incomplete, this must specify how the presentation will be completed. MT Mapping: field 77 settlement_account: type: array items: $ref: '#/components/schemas/CashAccount' instructions_from_bank: maxLength: 210 minLength: 1 type: string description: 'Instructions received from bank. MT Mapping: field 72Z' documentation: type: array description: 'Document(s) presented for examination. MT Mapping: field 23X' items: $ref: '#/components/schemas/Document' bank_instructions: maxLength: 3250 minLength: 1 type: string description: >- Instructions from the requesting bank. MT Mapping: field 78B of MT 798 last_date_for_response: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: >- Last date for a response to the bank instructions. MT Mapping: field 31T of MT 798 x-MXComponent: ISODate bank_contact: type: array items: $ref: '#/components/schemas/Contacts' extend_or_pay_text: maxLength: 3250 minLength: 1 type: string description: >- Specify the text of the request to extend or pay. MT Mapping: field 49J of MT 798 additionalProperties: false description: Details of the demand payment request. ISO2ALanguageCode: pattern: ^[a-z]{2,2}$ type: string description: > Identification of the language name according to the ISO 639-1 codes. The type is validated by the list of values coded with two alphabetic characters, defined in the standard. usage : This field is applicable for Issaunce of Bank guarantee Location: type: object properties: country: pattern: ^[A-Z]{2,2}$ type: string description: >- Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). x-Validation: true x-ValidationType: Algorithmic, ReferenceData x-Error: >- ErrorCode:Sw.Stds.D00004, ErrorText:Invalid Country Code., Severity:Fatal text: maxLength: 65 minLength: 1 type: string description: Name of jurisdiction, for example, Frankfurt. additionalProperties: false description: Location information. OrganisationIdentification: type: object properties: any_bic: pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ type: string description: > Business identification code of the organisation. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)". x-MXComponent: AnyBICDec2014Identifier x-Validation: true x-ValidationType: Algorithmic x-Error: >- ErrorCode:Sw.Stds.D00008, ErrorText:Invalid BIC., CitiValidation:true Severity:Fatal lei: pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ type: string description: >- Legal entity identification as an alternate identification for a party. x-MXComponent: LEIIdentifier other: maxItems: 2 type: array description: >- Unique identification of an organisation, as assigned by an institution, using an identification scheme. items: $ref: '#/components/schemas/GenericOrganisationIdentification' additionalProperties: false description: Unique and unambiguous way to identify an organisation. OrganisationIdentificationSchemeNameChoice: title: OrganisationIdentificationSchemeName type: object additionalProperties: true description: >- Sets of elements to identify a name of the organisation identification scheme. oneOf: - title: OrganisationIdentificationSchemeNameCode required: - code type: object properties: code: maxLength: 4 minLength: 1 type: string description: >- Name of the identification scheme, in a coded form as published in an external list. x-MXComponent: ExternalOrganisationIdentificationCode additionalProperties: false - title: OrganisationIdentificationSchemeNameProprietary required: - proprietary type: object properties: proprietary: maxLength: 35 minLength: 1 type: string description: Name of the identification scheme, in a free text form. additionalProperties: false PartyAndSignature: required: - digital_signature - name type: object properties: name: maxLength: 140 minLength: 1 type: string description: >- Name by which a party is known and which is usually used to identify that party. digital_signature: maxLength: 2048 minLength: 1 type: string description: Digital signature of the linked binary file. additionalProperties: false description: Entity involved in an activity. PartyIdentification: type: object properties: name: maxLength: 140 minLength: 1 type: string description: >- Name by which a party is known and which is usually used to identify that party. address_line: maxItems: 3 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. It is recommended to use dedicated elements like TownName, CountrySubDivision, PostCode, Country etc. as much as possible. MT Mapping: Address from fields 50, 51, 52a, 59a, 56a, 57a. items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text country: $ref: '#/components/schemas/CountryCode' identification: $ref: '#/components/schemas/PartyIdentificationChoice' country_of_residence: $ref: '#/components/schemas/CountryCode' additionalProperties: false description: Specifies the identification of a person or an organisation. PartyIdentificationChoice: title: PartyIdentification type: object additionalProperties: true description: >- Identify the type of party identification as either organisation identification or individual identification. oneOf: - title: OrganisationIdentification required: - organisation_identification type: object properties: organisation_identification: $ref: '#/components/schemas/OrganisationIdentification' additionalProperties: false - title: IndividualIdentification required: - private_identification type: object properties: private_identification: $ref: '#/components/schemas/PersonIdentification' additionalProperties: false PartyIdentificationDetail: required: - type type: object properties: type: maxLength: 4 minLength: 4 type: string description: "Type of Party can be either - a code from the list published on ISO20022.org as part of external code sets OR - if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used RULE: MANDATORY to include one iteration of Party for Applicant and another one for Beneficiary.\n\nCode Name Definition:\n\n* ADVP - AdvisingParty - Party advising the undertaking. \n* ANYB - AnyBank - Any bank. \n* APPL - Applicant - Party named in the undertaking as the “applicantâ€\x9D.\n* BENE - Beneficiary - Party in whose favour the undertaking (or counter-undertaking) is issued. \n* CONF - ConfirmationParty - Party that adds its undertaking to honour the undertaking. \n* CUB2 - SecondCounterUndertakingBeneficiary - Beneficiary of the second counter-undertaking. \n* CUB3 - ThirdCounterUndertakingBeneficiary - Beneficiary of the third counter-undertaking. \n* ISSU - Issuer - Party that issues the undertaking (or counter-undertaking).\n* OTHR - Other - Party not part of the list of codes.\n* OBLG - Obligor - Party obligated to reimburse the issuer. \n* ORDR - OrderingParty - Party requested to issue an undertaking on behalf of the applicant. Also known as the ordering institution or applicant''s bank. \n* PRES - PresentingParty - Party nominated to receive presentation. \n* SADV - SecondAdvisingParty - Second advising party. \n* SPEC - SpecifiedAddress - Party located at specified address.\n\nMT Mapping: Party fields like 50, 51, 52a, 59a, 56a, 57a'\n" identification: maxLength: 35 minLength: 1 type: string description: | Unique and unambiguous identifier assigned by the party. Usage :- This field is Mandatory for Applicant and Beneficiary only issuer: maxLength: 35 minLength: 1 type: string description: Not applicable. any_bic: $ref: '#/components/schemas/AnyBICDec2014Identifier' lei: pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ type: string description: Legal entity identifier of the financial institution. x-MXComponent: LEIIdentifier name: maxLength: 35 minLength: 1 type: string description: >- Name by which a party is known and which is usually used to identify that party. RULE: If AnyBIC is absent then Name is mandatory and it is recommended to also provide the Postal Address. RULE: If Postal Address is present then Name is mandatory. MT Mapping: Name from fields 50, 51, 52a, 59a, 56a, 57a. x-MTComponent: RestrictedFINXMax35Text address_line: maxItems: 3 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. It is recommended to use dedicated elements like TownName, CountrySubDivision, PostCode, Country etc. as much as possible. MT Mapping: Address from fields 50, 51, 52a, 59a, 56a, 57a. items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text country: $ref: '#/components/schemas/CountryCode' contact_name: maxLength: 35 minLength: 1 type: string description: >- Name by which a party is known and which is usually used to identify that party. Part of a set of elements used to indicate how to contact the party. x-MTComponent: RestrictedFINXMax35Text contact_phone_number: $ref: '#/components/schemas/PhoneNumber' contact_email_address: type: string description: >- Address for electronic mail (e-mail). Part of a set of elements used to indicate how to contact the party. format: email additional_details: maxLength: 35 minLength: 1 type: string description: > Additional details of the party. Usage Guideline: This field can additionally be used to identify the party when the party type is 'OTHR'. additionalProperties: false description: Set of elements used to identify a person or an organisation. PartyIdentificationSummary: type: object properties: any_bic: $ref: '#/components/schemas/AnyBICDec2014Identifier' lei: pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ type: string description: Legal entity identifier of the financial institution. x-MXComponent: LEIIdentifier name: maxLength: 140 minLength: 1 type: string description: >- Name by which a party is known and which is usually used to identify that party. RULE: If AnyBIC is absent then Name is mandatory and it is recommended to also provide the Postal Address. RULE: If Postal Address is present then Name is mandatory. address_line: maxItems: 3 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. It is recommended to use dedicated elements like TownName, CountrySubDivision, PostCode, Country etc. as much as possible. items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text location: maxLength: 35 minLength: 1 type: string country: pattern: ^[A-Z]{2,2}$ type: string description: Nation with its own government. x-Validation: true x-ValidationType: Algorithmic, ReferenceData x-Error: >- ErrorCode:Sw.Stds.D00004, ErrorText:Invalid Country Code., CitiValidation:true, Severity:Fatal additionalProperties: false description: Set of elements used to identify a person or an organisation. PersonIdentification: type: object properties: date_and_place_of_birth: $ref: '#/components/schemas/DateAndPlaceOfBirth' other: maxItems: 2 type: array description: >- Unique identification of a person, as assigned by an institution, using an identification scheme. items: $ref: '#/components/schemas/GenericPersonIdentification' additionalProperties: false description: Unique and unambiguous way to identify a person. PersonIdentificationSchemeNameChoice: title: PersonIdentificationSchemeName type: object additionalProperties: true description: Sets of elements to identify a name of the identification scheme. oneOf: - title: PersonIdentificationSchemeNameCode required: - code type: object properties: code: maxLength: 4 minLength: 1 type: string description: >- Name of the identification scheme, in a coded form as published in an external list. x-MXComponent: ExternalPersonIdentificationCode additionalProperties: false - title: PersonIdentificationSchemeNameProprietary required: - proprietary type: object properties: proprietary: maxLength: 35 minLength: 1 type: string description: Name of the identification scheme, in a free text form. additionalProperties: false PhoneNumber: pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$ type: string description: > The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). PlaceOfPresentation: required: - place type: object properties: place: maxLength: 4 minLength: 4 type: string description: "Place of the presentation. Place of the presentation can be either - a code from the list published on ISO20022.org as part of external code sets OR - if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used.\n\nCode Name Definition:\n\n* ADVP - AdvisingParty - Party advising the undertaking. \n* ANYB - AnyBank - Any bank. \n* APPL - Applicant - Party named in the undertaking as the “applicantâ€\x9D.\n* BENE - Beneficiary - Party in whose favour the undertaking (or counter-undertaking) is issued. \n* CONF - ConfirmationParty - Party that adds its undertaking to honour the undertaking. \n* CUB2 - SecondCounterUndertakingBeneficiary - Beneficiary of the second counter-undertaking. \n* CUB3 - ThirdCounterUndertakingBeneficiary - Beneficiary of the third counter-undertaking. \n* ISSU - Issuer - Party that issues the undertaking (or counter-undertaking). \n* OBLG - Obligor - Party obligated to reimburse the issuer. \n* ORDR - OrderingParty - Party requested to issue an undertaking on behalf of the applicant. Also known as the ordering institution or applicant's bank. \n* PRES - PresentingParty - Party nominated to receive presentation. \n* SADV - SecondAdvisingParty - Second advising party. \n* SPEC - SpecifiedAddress - Party located at specified address.\n" country: pattern: ^[A-Z]{2,2}$ type: string description: Country where a presentation is to be made. x-Validation: true x-ValidationType: Algorithmic, ReferenceData x-Error: >- ErrorCode:Sw.Stds.D00004, ErrorText:Invalid Country Code., CitiValidation:true, Severity:Fatal additionalProperties: false description: Location of a presentation. PlaceOrUnderConfirmationChoice: title: PlaceOrUnderConfirmation type: object additionalProperties: true description: Choice between a location and codified form. oneOf: - title: PlaceOfPresentation required: - place_of_presentation type: object properties: place_of_presentation: $ref: '#/components/schemas/PlaceOfPresentation' additionalProperties: false - title: PresentationUnderConfirmation required: - presentation_under_confirmation type: object properties: presentation_under_confirmation: $ref: '#/components/schemas/PresentationPartyCode' additionalProperties: false Presentation: type: object properties: format: maxLength: 4 minLength: 4 type: string description: | Format for presentation documents that are submitted electronically. Code Name Definition: * CODE - Format of document * DPDF - PDF * DXML - XML * OTHR - Other * SDSH - Spreadsheet * WORD - Word * XSLT - XSLT channel: maxLength: 4 minLength: 4 type: string description: >- Channel through which presentation documents are submitted electronically address: type: string description: >- Uniform Resource Identifier (URI), such as a web or an email address, specifying where the presentation can be addressed. format: uri additional_details: maxLength: 35 minLength: 1 type: string description: > Additional information related to 'Deliver to' information. Usage Guideline: This field can additionally be used to identify the format and channel when the format and channel code is 'OTHR'. Recommend to structure the information as follows (example): When Format is Other - //OTHR//JPEG When Channel is Other - //OTHR//HOST When both Format and Channel is Other - //OTHR//JPEG//OTHR//HOST additionalProperties: false description: Electronic presentation information. PresentationPartyCode: maxLength: 4 minLength: 4 type: string description: > Specifies the party to receive the presentation. Code Name Definition: * ETHR - Presentation made either to the issuer or other nominated party. * EXCN - Presentation made exclusively to the confirmer. * EXIS - Presentation made exclusively to the issuer. enum: - ETHR - EXCN - EXIS TradeConfirmationTypeCode: maxLength: 7 minLength: 6 type: string description: > This field contains confirmation instructions from the issuing bank to the advising party. Code Name Definition: * CONFIRM - The requested confirmation party is requested to confirm the credit * MAYADD - The requested confirmation party may add its confirmation to the credit * WITHOUT - No confirmation is requested enum: - CONFIRM - MAYADD - WITHOUT TradeFinanceInstruction: required: - applicant_issuance_request_identification - undertaking_application_date - undertaking_form - governance_rule_identification - party - undertaking_amount - undertaking_text_purpose - undertaking_terms_and_conditions - issuance_type - expiry_type - confirmation_instructions type: object properties: application_reference: type: string description: > An unique and unambiguous identification of the Trade Finance Undertaking Application as assigned by the Citi Bank. The value must be constant throughout the lifecycle of the application. On successful creation, the application can be retrieved using the application reference. This identification shall be used as a resource identifier for all state transition. Usage - Unique end to end reference of the Trade Finance Undertaking application. The value must be constant throughout the lifecycle of the application. The type is Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". format: uuid readOnly: true platform_reference: x-MXComponent: UUIDv4Identifier description: > Unique technical reference assigned by the platform. Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". type: string pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ applicant_issuance_request_identification: maxLength: 16 minLength: 1 type: string description: > Unique business reference of the Issuance Request, assigned by the applicant i.e. Corporate ref number. MT Mapping: field 21A of MT 798." Usage : It is Applicable only for Issue of Bank Guarantee. x-MTComponent: RestrictedFINXMax16Text issuer_acknowledgement_identification: maxLength: 16 minLength: 1 type: string description: > Unique business reference of the issuer's acknowledgement of the applicant's initial Issuance Request, assigned by the issuer.Field should be blank when applicant submits the initial issuance request. For subsiquient request , Use application-reference sent by Citi in the "202" API response for initial issuance request. Usage : It is Applicable only for Amendment of Bank Guarantee. x-MTComponent: RestrictedFINXMax16Text undertaking_identification: maxLength: 16 minLength: 1 type: string description: > Unique business identification of the undertaking. Filled in by the bank after issuance of the Undertaking, stays unique throughout the lifecycle of the Undertaking i.e.Citi bank Our ref number.Field should be blank when applicant submits the initial issuance request. \n\nUsage \n\nMT Mapping: field 20. Usage : It is Applicable only for Amendment of Bank Guarantee. readOnly: true x-MTComponent: RestrictedFINXMax16Text third_party_issuance_request_identification: description: Not applicable.Keep it blank undertaking_application_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. MT Mapping: 13E." Usage: This fields is applicable for Issuance of Bank Guarantee. x-MXComponent: ISODate undertaking_issuance_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Date on which the Trade Finance Undertaking is issued by the issuing bank. This date will be provided by the applicant's bank/issuer when the undertaking is issued. Usage: This fields is applicable for Amend of Bank Guarantee. readOnly: true x-MXComponent: ISODate undertaking_status: type: string description: > Specifies the state of a Trade Finance Undertaking in its processing cycle. Type of bankg guarantee status, in a codified form * AMRQ - Trade Finance Undertaking Amendment Request * APPL - Trade Finance Undertaking Application Usage:- This field is applicable for both Issuance and Amend ment of Guarantee readOnly: true enum: - AMRQ - APPL undertaking_form: $ref: '#/components/schemas/FormOfUndertakingCode' undertaking_text_purpose: $ref: '#/components/schemas/UndertakingPurposeCode' issuance_type: maxLength: 4 minLength: 4 type: string description: > Type of the undertaking issuance. Code Name Definition: * ICCO - Issuance of counter-counter-undertaking and request to issue counter-undertaking * ISCO - Issuance of counter-undertaking and request to issue local undertaking * ISSU - Issuance of undertaking Usage: This field is applicbale for Issuance of Bank Guarantee. MT Mapping: field 22A of MT 798. undertaking_type: maxLength: 4 minLength: 4 type: string description: > Type of undertaking, for example, performance, payment. Type of undertaking can be either - Code from ExternalUndertakingType1Code published on ISO20022.org as part of external code sets OR - if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used.\n\nCode Name Definition: \n * APAY - AdvancePayment - Undertaking in support of an advance payment obligation. \n * COMM - Commercial - Undertaking in support of a commercial obligation\n * CUST - Customs - Undertaking in support of a customs duty obligation.\n * DPAY - DirectPay - Undertaking representing the primary means of payment.\n * FINC - Financial - Undertaking in support of a financial obligation.\n * INSU - Insurance - Undertaking in support of a insurance obligation.\n * IRBO - IndustrialRevenueBoard - Undertaking in support of an Industrial Revenue Board (IRB) obligation. \n * MAIN - Maintenance - Undertaking in support of a maintenance obligation.\n * OTHR - Other - Undertaking in support of any other type.\n * PAYM - Payment - Undertaking in support of a payment obligation. \n * PERF - Performance - Undertaking in support of a performance obligation. \n * RETN - Retention - Undertaking in support of a monetary retention obligation. \n * SHIP - Shipping - Undertaking in support of a sea transportation obligation. \n * TEND - TenderOrBid - Undertaking in support of a tender or bid obligation. \n * WARR - Warranty - Undertaking in support of a warranty obligation. MT Mapping: field 22K Usage : This fields is applicable for Issaune of Guarantee undertaking_wording_type: maxLength: 4 minLength: 4 type: string description: > Specifies the type of wording of the guarantee.\n\nCode Name Definition: * STND - Standard wording of issuing/local bank * OTHR - Must be specified in Narrative\n\nIf code is different from the above code list, then a bilaterally agreed code may be used. Usage :-This field is applicable for Issuance of Bank Guarantee MT Mapping: field 12H of MT 798. standard_wording_language: $ref: '#/components/schemas/ISO2ALanguageCode' party: minItems: 1 type: array description: >- Parties specified in the undertaking or related to the undertaking. The type of Party is specified in the first element, Type. RULE: MANDATORY to include one iteration of Party for Applicant and another one for Beneficiary. items: $ref: '#/components/schemas/PartyIdentificationDetail' undertaking_amount: $ref: '#/components/schemas/ActiveCurrencyAndAmount' undertaking_amount_additional_information: maxLength: 780 minLength: 1 type: string description: > Additional information concerning the demand amount. MT Mapping: field 39F Usage : It is used for Issuance of Bank Guarantee expiry_type: $ref: '#/components/schemas/ExpiryTypeCode' undertaking_expiry_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Date when the undertaking will cease to be available. MT Mapping: field 31E Usage : It is applicable for issuance and Amendment bank of Guarantee. x-MXComponent: ISODate undertaking_expiry_condition: maxLength: 780 minLength: 1 type: string description: > Documentary condition that indicates when the undertaking will cease to be available.This field will be available only expriy type is COND.MT Mapping: field 35G. Usage : it is applicable for Issuance and Amendment of Bank Guarantee expiry_open_ended_indicator: type: boolean description: >- Indicates whether the expiry terms are without a fixed expiry date. MT Mapping: field 23B confirmation_instructions: description: | Usage: - It is applicable for Issuance of Bank Guarantee Only. $ref: '#/components/schemas/TradeConfirmationTypeCode' undertaking_terms_and_conditions: maxItems: 8 type: array description: | Terms and conditions of the undertaking. Usage:- It is applicable for Issuance and Amend of Bank Guarantee MT Mapping: field 77U" items: maxLength: 9750 minLength: 1 type: string auto_extension_period: $ref: '#/components/schemas/AutoExtendChoice' auto_extension_final_expiry_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: >- Final expiry date after which the undertaking will no longer be subject to automatic extension. This field will be available only expriy type is COND. MT Mapping: field 31S x-MXComponent: ISODate auto_extension_notification_period: type: integer description: > Minimum number of days prior to the then current expiry date by which notice of non-extension must be sent. This field will be available only expriy type is COND . Usage : it is applicable for Issuance and Amendment only. MT Mapping: field 26". format: int32 auto_extension_non_extension_notification_narrative: maxLength: 780 minLength: 1 type: string description: > This field contains additional details about the non-extension to the automatic expiry date extension. MT Mapping: field 78 usage : It is applicable fo Issuance of Bank Guarantee governance_rule_identification: $ref: '#/components/schemas/GovernanceIdentificationCode' governance_rule_narrative: maxLength: 35 minLength: 1 type: string description: > If Type is OTHR, then Narrative may be present, otherwise Narrative is not allowed. Usage : - It is applicable for Issaunce of Bank Guarantee applicable_law_or_jurisdiction: $ref: '#/components/schemas/Location' underlying_transaction_additional_info: maxLength: 3250 minLength: 1 type: string description: > Additional information related to the underlying transaction.Specifies concise details of the underlying busines transaction for which the undertaking is issued. Usage :- It is applicable fo Issuanc of Bank Guarantee. presentation_instructions: maxLength: 6500 minLength: 1 type: string description: >- This field specifies the presentation instructions (for example, form and/or place of presentation) including documents required to make a complying demand. Presentation refers to presentation of documents that conform to the Terms and Conditions of the Undertaking. MT Mapping: field 45C presentation_document: type: array description: Not Applicable items: $ref: '#/components/schemas/DocumentSummary' presentation_medium: maxLength: 4 minLength: 4 type: string description: Not Applicable presentation_representation: $ref: '#/components/schemas/PlaceOrUnderConfirmationChoice' partial_demand_indicator: $ref: '#/components/schemas/DemandCode' transfer_indicator: type: boolean description: > Indicates whether the undertaking is transferable. MT Mapping: field 48D Usage :- This field is applicable for Issuance of Bank Guarantee. transfer_conditions: maxLength: 780 minLength: 1 type: string description: Not Applicable charge: type: array description: > Specify charges including charges applicable during settlement of an Undertaking. Note: For each different charge, recommendation is to repeat Charge. For example, counterparty commission, own charges, refund charges etc. should be indicated by repeating Charge. items: $ref: '#/components/schemas/Charge' delivery_channel_method: maxLength: 4 minLength: 4 type: string description: | Method by which the original undertaking is to be made available. Code Name Definition * COUR - Courier * MESS - Messenger * OTHR - Other * REGM - RegisteredMail * COLL - BY collection * MAIL - Ny Mail Usage -> This field is applicable for Issuance and Amend of Bank Guarantee MT Mapping: field 24E deliver_to_party_type: maxLength: 4 minLength: 4 type: string description: > Type of party to whom the original undertaking is intended to be delivered. Type of party can be either - a code from the list published on ISO20022.org as part of external code sets OR - if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used. Code Name Definition: * OTHR - Other * BENE - Beneficiary Usage -> * This field is applicable for Issuance and Amend of Bank Guarantee. * This field is applicable only when Issuance_type is ISSU deliver_to_name: maxLength: 35 minLength: 1 type: string description: Not Applicable x-MTComponent: RestrictedFINXMax35Text deliver_to_address: maxItems: 3 type: array description: Not Applicable items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text deliver_to_tracking_reference: maxLength: 35 minLength: 1 type: string description: > Unique tracking reference used by the delivery method, for example courier tracking reference etc." * This field is applicable for Issuance and Amend of Bank Guarantee. * This field is applicable only when Issuance_type is ISSU * This field Applicable when delivery_channel_method is COUR deliver_to_electronic_details: type: array description: Not Applicable. items: $ref: '#/components/schemas/Presentation' additional_deliver_to_details: maxLength: 35 minLength: 1 type: string description: | Additional details about delivery. Usage Guideline: * This field can additionally be used to identify the party when the party type is 'OTHR'. * This field is applicable for Issuance and Amend of Bank Guarantee. supporting_document: type: array description: Not Applicable. items: $ref: '#/components/schemas/Document' instructions_to_bank: maxLength: 210 minLength: 1 type: string description: >- Information specific to the bank receiving the instruction. MT Mapping: field 72Z application_advice_information: maxLength: 3250 minLength: 1 type: string description: >- Additional information about the Application. MT Mapping: field 78B of MT 798 amendment_request_supporting_information: $ref: '#/components/schemas/BankGuaranteeAmendment2Subset' TradeFinanceAmends: required: - undertaking_identification - amendment_request_supporting_information type: object properties: application_reference: type: string description: > An unique and unambiguous identification of the Trade Finance Undertaking Application as assigned by the Citi Bank. The value must be constant throughout the lifecycle of the application. On successful creation, the application can be retrieved using the application reference. This identification shall be used as a resource identifier for all state transition. Usage - Unique end to end reference of the Trade Finance Undertaking application. The value must be constant throughout the lifecycle of the application. The type is Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". format: uuid readOnly: true platform_reference: x-MXComponent: UUIDv4Identifier description: > Unique technical reference assigned by the platform. Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". type: string pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ applicant_issuance_request_identification: maxLength: 16 minLength: 1 type: string description: > Unique business reference of the Issuance Request, assigned by the applicant i.e. Corporate ref number. MT Mapping: field 21A of MT 798." Usage : It is Applicable only for Issue of Bank Guarantee. x-MTComponent: RestrictedFINXMax16Text issuer_acknowledgement_identification: maxLength: 16 minLength: 1 type: string description: > Unique business reference of the issuer's acknowledgement of the applicant's initial Issuance Request, assigned by the issuer.Field should be blank when applicant submits the initial issuance request. For subsiquient request , Use application-reference sent by Citi in the "202" API response for initial issuance request. Usage : It is Applicable only for Amendment of Bank Guarantee. x-MTComponent: RestrictedFINXMax16Text undertaking_identification: maxLength: 16 minLength: 1 type: string description: > Unique business identification of the undertaking. Filled in by the bank after issuance of the Undertaking, stays unique throughout the lifecycle of the Undertaking i.e.Citi bank Our ref number.Field should be blank when applicant submits the initial issuance request. \n\nUsage \n\nMT Mapping: field 20. Usage : It is Applicable only for Amendment of Bank Guarantee. readOnly: true x-MTComponent: RestrictedFINXMax16Text third_party_issuance_request_identification: description: Not applicable.Keep it blank undertaking_application_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. MT Mapping: 13E." Usage: This fields is applicable for Issuance of Bank Guarantee. x-MXComponent: ISODate undertaking_issuance_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Date on which the Trade Finance Undertaking is issued by the issuing bank. This date will be provided by the applicant's bank/issuer when the undertaking is issued. Usage: This fields is applicable for Amend of Bank Guarantee. readOnly: true x-MXComponent: ISODate undertaking_status: type: string description: > Specifies the state of a Trade Finance Undertaking in its processing cycle. Type of bankg guarantee status, in a codified form * AMRQ - Trade Finance Undertaking Amendment Request * APPL - Trade Finance Undertaking Application Usage:- This field is applicable for both Issuance and Amend ment of Guarantee readOnly: true enum: - AMRQ - APPL undertaking_form: $ref: '#/components/schemas/FormOfUndertakingCode' undertaking_text_purpose: $ref: '#/components/schemas/UndertakingPurposeCode' issuance_type: maxLength: 4 minLength: 4 type: string description: > Type of the undertaking issuance. Code Name Definition: * ICCO - Issuance of counter-counter-undertaking and request to issue counter-undertaking * ISCO - Issuance of counter-undertaking and request to issue local undertaking * ISSU - Issuance of undertaking Usage: This field is applicbale for Issuance of Bank Guarantee. MT Mapping: field 22A of MT 798. undertaking_type: maxLength: 4 minLength: 4 type: string description: > Type of undertaking, for example, performance, payment. Type of undertaking can be either - Code from ExternalUndertakingType1Code published on ISO20022.org as part of external code sets OR - if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used.\n\nCode Name Definition: \n * APAY - AdvancePayment - Undertaking in support of an advance payment obligation. \n * COMM - Commercial - Undertaking in support of a commercial obligation\n * CUST - Customs - Undertaking in support of a customs duty obligation.\n * DPAY - DirectPay - Undertaking representing the primary means of payment.\n * FINC - Financial - Undertaking in support of a financial obligation.\n * INSU - Insurance - Undertaking in support of a insurance obligation.\n * IRBO - IndustrialRevenueBoard - Undertaking in support of an Industrial Revenue Board (IRB) obligation. \n * MAIN - Maintenance - Undertaking in support of a maintenance obligation.\n * OTHR - Other - Undertaking in support of any other type.\n * PAYM - Payment - Undertaking in support of a payment obligation. \n * PERF - Performance - Undertaking in support of a performance obligation. \n * RETN - Retention - Undertaking in support of a monetary retention obligation. \n * SHIP - Shipping - Undertaking in support of a sea transportation obligation. \n * TEND - TenderOrBid - Undertaking in support of a tender or bid obligation. \n * WARR - Warranty - Undertaking in support of a warranty obligation. MT Mapping: field 22K Usage : This fields is applicable for Issaune of Guarantee undertaking_wording_type: maxLength: 4 minLength: 4 type: string description: > Specifies the type of wording of the guarantee.\n\nCode Name Definition: * STND - Standard wording of issuing/local bank * OTHR - Must be specified in Narrative\n\nIf code is different from the above code list, then a bilaterally agreed code may be used. Usage :-This field is applicable for Issuance of Bank Guarantee MT Mapping: field 12H of MT 798. standard_wording_language: $ref: '#/components/schemas/ISO2ALanguageCode' party: minItems: 1 type: array description: >- Parties specified in the undertaking or related to the undertaking. The type of Party is specified in the first element, Type. RULE: MANDATORY to include one iteration of Party for Applicant and another one for Beneficiary. items: $ref: '#/components/schemas/PartyIdentificationDetail' undertaking_amount: $ref: '#/components/schemas/ActiveCurrencyAndAmount' undertaking_amount_additional_information: maxLength: 780 minLength: 1 type: string description: > Additional information concerning the demand amount. MT Mapping: field 39F Usage : It is used for Issuance of Bank Guarantee expiry_type: $ref: '#/components/schemas/ExpiryTypeCode' undertaking_expiry_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: > Date when the undertaking will cease to be available. MT Mapping: field 31E Usage : It is applicable for issuance and Amendment bank of Guarantee. x-MXComponent: ISODate undertaking_expiry_condition: maxLength: 780 minLength: 1 type: string description: > Documentary condition that indicates when the undertaking will cease to be available.This field will be available only expriy type is COND.MT Mapping: field 35G. Usage : it is applicable for Issuance and Amendment of Bank Guarantee expiry_open_ended_indicator: type: boolean description: >- Indicates whether the expiry terms are without a fixed expiry date. MT Mapping: field 23B confirmation_instructions: description: | Usage: - It is applicable for Issuance of Bank Guarantee Only. $ref: '#/components/schemas/TradeConfirmationTypeCode' undertaking_terms_and_conditions: maxItems: 8 type: array description: | Terms and conditions of the undertaking. Usage:- It is applicable for Issuance and Amend of Bank Guarantee MT Mapping: field 77U" items: maxLength: 9750 minLength: 1 type: string auto_extension_period: $ref: '#/components/schemas/AutoExtendChoice' auto_extension_final_expiry_date: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string description: >- Final expiry date after which the undertaking will no longer be subject to automatic extension. This field will be available only expriy type is COND. MT Mapping: field 31S x-MXComponent: ISODate auto_extension_notification_period: type: integer description: > Minimum number of days prior to the then current expiry date by which notice of non-extension must be sent. This field will be available only expriy type is COND . Usage : it is applicable for Issuance and Amendment only. MT Mapping: field 26". format: int32 auto_extension_non_extension_notification_narrative: maxLength: 780 minLength: 1 type: string description: > This field contains additional details about the non-extension to the automatic expiry date extension. MT Mapping: field 78 usage : It is applicable fo Issuance of Bank Guarantee governance_rule_identification: $ref: '#/components/schemas/GovernanceIdentificationCode' governance_rule_narrative: maxLength: 35 minLength: 1 type: string description: > If Type is OTHR, then Narrative may be present, otherwise Narrative is not allowed. Usage : - It is applicable for Issaunce of Bank Guarantee applicable_law_or_jurisdiction: $ref: '#/components/schemas/Location' underlying_transaction_additional_info: maxLength: 3250 minLength: 1 type: string description: > Additional information related to the underlying transaction.Specifies concise details of the underlying busines transaction for which the undertaking is issued. Usage :- It is applicable fo Issuanc of Bank Guarantee. presentation_instructions: maxLength: 6500 minLength: 1 type: string description: >- This field specifies the presentation instructions (for example, form and/or place of presentation) including documents required to make a complying demand. Presentation refers to presentation of documents that conform to the Terms and Conditions of the Undertaking. MT Mapping: field 45C presentation_document: type: array description: Not Applicable items: $ref: '#/components/schemas/DocumentSummary' presentation_medium: maxLength: 4 minLength: 4 type: string description: Not Applicable presentation_representation: $ref: '#/components/schemas/PlaceOrUnderConfirmationChoice' partial_demand_indicator: $ref: '#/components/schemas/DemandCode' transfer_indicator: type: boolean description: > Indicates whether the undertaking is transferable. MT Mapping: field 48D Usage :- This field is applicable for Issuance of Bank Guarantee. transfer_conditions: maxLength: 780 minLength: 1 type: string description: Not Applicable charge: type: array description: > Specify charges including charges applicable during settlement of an Undertaking. Note: For each different charge, recommendation is to repeat Charge. For example, counterparty commission, own charges, refund charges etc. should be indicated by repeating Charge. items: $ref: '#/components/schemas/Charge' delivery_channel_method: maxLength: 4 minLength: 4 type: string description: | Method by which the original undertaking is to be made available. Code Name Definition * COUR - Courier * MESS - Messenger * OTHR - Other * REGM - RegisteredMail * COLL - BY collection * MAIL - Ny Mail Usage -> This field is applicable for Issuance and Amend of Bank Guarantee MT Mapping: field 24E deliver_to_party_type: maxLength: 4 minLength: 4 type: string description: > Type of party to whom the original undertaking is intended to be delivered. Type of party can be either - a code from the list published on ISO20022.org as part of external code sets OR - if code is different from the ISO code list (mentioned above), then a bilaterally agreed code may be used. Code Name Definition: * OTHR - Other * BENE - Beneficiary Usage -> * This field is applicable for Issuance and Amend of Bank Guarantee. * This field is applicable only when Issuance_type is ISSU deliver_to_name: maxLength: 35 minLength: 1 type: string description: Not Applicable x-MTComponent: RestrictedFINXMax35Text deliver_to_address: maxItems: 3 type: array description: Not Applicable items: maxLength: 35 minLength: 1 type: string x-MTComponent: RestrictedFINXMax35Text deliver_to_tracking_reference: maxLength: 35 minLength: 1 type: string description: > Unique tracking reference used by the delivery method, for example courier tracking reference etc." * This field is applicable for Issuance and Amend of Bank Guarantee. * This field is applicable only when Issuance_type is ISSU * This field Applicable when delivery_channel_method is COUR deliver_to_electronic_details: type: array description: Not Applicable. items: $ref: '#/components/schemas/Presentation' additional_deliver_to_details: maxLength: 35 minLength: 1 type: string description: | Additional details about delivery. Usage Guideline: * This field can additionally be used to identify the party when the party type is 'OTHR'. * This field is applicable for Issuance and Amend of Bank Guarantee. supporting_document: type: array description: Not Applicable. items: $ref: '#/components/schemas/Document' instructions_to_bank: maxLength: 210 minLength: 1 type: string description: >- Information specific to the bank receiving the instruction. MT Mapping: field 72Z application_advice_information: maxLength: 3250 minLength: 1 type: string description: >- Additional information about the Application. MT Mapping: field 78B of MT 798 amendment_request_supporting_information: $ref: '#/components/schemas/BankGuaranteeAmendment3Subset' TradeFinanceInstructionReference: type: object properties: application-reference: type: string description: > An unique and unambiguous identification of the Trade Finance Undertaking Application as assigned by the origin server. The value must be constant throughout the lifecycle of the application. On successful creation, the application can be retrieved using the application reference. This identification shall be used as a resource identifier for all state transition. Usage - Unique end to end reference of the Trade Finance Undertaking application. The value must be constant throughout the lifecycle of the application. The type is Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". format: uuid additionalProperties: false description: >- Trade Finance Undertaking Application Reference to identify a Trade Finance Undertaking Application throughout the application lifecycle. UndertakingPurposeCode: maxLength: 4 minLength: 4 type: string description: > This field specifies whether the application text is draft or final. Code Name Definition: * FINL - Final submission requesting/authorizing issuance of a guarantee / standby Usage:--> This field is applicable for Amendment of Bank guarantee enum: - FINL Link: required: - href type: object properties: href: maxLength: 256 type: string description: >- Specifies the link as a url. The href member identifies the target IRI location of the resource. format: uri rel: maxLength: 35 type: string description: >- Specifies the operation. The value of this property MUST be a string. This property is required except self. The self reference contains the URI of the same resource. type: maxLength: 35 type: string description: >- The value containing the HTTP verb used for the URL. If the type element is not included then the link MUST be available using GET. format: uri additionalProperties: false description: Contains a generic structure to support hyperlinking (REST level 3). readOnly: true Errors: type: array description: >- Container to return multiple ErrorMessage object. Collection of error can be useful when API needs to return multiple errors, for example validation errors. When the response code conveys application-specific functional semantics and consumer can parse machine-readable error code, this block can be useful. The error response must contain at least one error object. items: $ref: '#/components/schemas/ErrorMessage' ErrorMessage: required: - code - severity - text type: object properties: severity: type: string description: Specifies the severity of the error. enum: - Fatal - Transient - Logic code: maxLength: 70 minLength: 3 type: string description: Specifies the custom error code as defined by the service provider. text: maxLength: 255 minLength: 1 type: string description: >- Specifies the detail error message identifying the cause of the error. user_message: maxLength: 255 minLength: 1 type: string description: A human-readable text describing the error. more_info: type: string description: Specifies an URL to find more information about the error. format: uri additionalProperties: false description: Custom error schema to support detailed error message. readOnly: true inline_response_200: type: object properties: trade_finance_instruction: type: array items: $ref: '#/components/schemas/TradeFinanceInstruction' links: type: array items: $ref: '#/components/schemas/Link' additionalProperties: false inline_response_400: oneOf: - $ref: '#/components/schemas/Errors' - $ref: '#/components/schemas/ErrorMessage' responses: 400-BadRequest: description: Bad Request headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 401-Unauthorized: description: Unauthorized headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 403-Forbidden: description: Forbidden headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 404-NotFound: description: Not Found headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 405-MethodNotAllowed: description: Method Not Allowed headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Errors' - $ref: '#/components/schemas/ErrorMessage' 406-NotAcceptable: description: Not Acceptable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 407-ProxyAuthenticationRequired: description: Proxy Authentication Required headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Errors' - $ref: '#/components/schemas/ErrorMessage' 409-Conflict: description: Conflict headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Errors' - $ref: '#/components/schemas/ErrorMessage' 410-Gone: description: Gone headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Errors' - $ref: '#/components/schemas/ErrorMessage' 412-PreconditionFailed: description: Precondition Failed headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 413-PayloadTooLarge: description: Payload Too Large headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Errors' - $ref: '#/components/schemas/ErrorMessage' 414-URITooLong: description: URI Too Long headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 415-UnsupportedMediaType: description: Unsupported Media Type headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 429-TooManyRequests: description: Too Many Requests headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 500-InternalServerError: description: Internal Server Error headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 502-BadGateway: description: Bad Gateway headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 503-ServiceUnavailable: description: Service Unavailable headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' 504-GatewayTimeout: description: Gateway Timeout headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/inline_response_400' parameters: If-Match: name: If-Match in: header description: >- This header will contain the Etag of the resource representation to be manipulate. If the server ETag value does not match with the provided ETag value, the error response 412 - precondition fail will be returned. This signifies the resource is out of date. required: false style: simple explode: false schema: type: string example: f88dd058fe004909615a64f01be66a7 pagination-offset: name: offset in: query description: >- Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. required: false style: form explode: false schema: minimum: 0 type: integer default: 0 example: 0 pagination-limit: name: limit in: query description: >- The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. required: false style: form explode: false schema: maximum: 100 minimum: 1 type: integer default: 25 example: 25 X-Request-ID: name: X-Request-ID in: header description: >- Specify an unique end to end tracking request ID. The element will be populated by the Citi API gateway required: false style: simple explode: false schema: type: string x-requiredByAPIGateway: true x-requiredByServiceProvider: true X-UserContext: name: X-UserContext in: header description: >- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the Citi Identity Provider. This header is provided by the Citi API Gateway and is not required to be provided by the API consumer. required: false style: simple explode: false schema: type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-e14JmCtQ X-BIC: name: X-BIC in: header description: >- Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider. required: true style: simple explode: false schema: type: string example: DEUTDEFF application-reference: name: application-reference in: path description: > An unique and unambiguous identification of the Trade Finance Undertaking Application as assigned by the origin server. The value must be constant throughout the lifecycle of the application. On successful creation, the application can be retrieved using the application reference. This identification shall be used as a resource identifier for all state transition. required: true style: simple explode: false schema: type: string format: uuid example: 123e456-e89b-12d3-a456-426614174000 undertaking-identification: name: undertaking-identification in: query description: > Globally unique identification of the Trade Finance Undertaking application. The value must be constant throughout the lifecycle of the account. This identification shall be used as a unique reference to support application lifecycle to support interoperability between API and other channel. Usage: The undertaking-identification must not be used in conjunction with any other filter criteria. The anticipation is that the value is unique to retrieve a specific application by the reference. required: false style: form explode: false schema: maxLength: 16 minLength: 1 type: string example: BGREQ30122022-01 applicant-issuance-request-identification: name: applicant-issuance-request-identification in: query description: > Unique business reference of the Issuance Request, assigned by the applicant. Usage: The undertaking-identification must not be used in conjunction with any other filter criteria. The anticipation is that the value is unique to retrieve a specific application by the reference. required: false style: form explode: false schema: maxLength: 16 minLength: 1 type: string example: XYZ999-123 application-date: name: application-date in: query description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage: The application-date must not be used in conjunction with application-from-date or application-to-date or issuance-date. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string application-from-date: name: application-from-date in: query description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage: The application-date must be used in conjunction with application-to-date. When used in conjunction with the application-to-date, the endpoint returns the application where the application date fall within that period. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string example: '2023-05-22' application-to-date: name: application-to-date in: query description: > Date on which the applicant lodge the application for issuance of Trade Finance Undertaking. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage: The application-date must not be used in conjunction with application-from-date. When used in conjunction with the application-from-date, the endpoint returns the application where the application date fall within that period. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string example: '2023-05-23' issuance-date: name: issuance-date in: query description: >- Date on which the Trade Finance Undertaking is issued by the issuing bank. Expressed in the YYYY-MM-DD format. The date cannot be in the future. required: false style: form explode: false schema: pattern: >- ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$ type: string application-lifecycle-status: name: application-lifecycle-status in: query description: > Specifies the state of a Trade Finance Undertaking in its processing cycle. Type of Trade Finance Undertaking status, in a codified form * AMRQ - Trade Finance Undertaking Amendment Request * APPL - Trade Finance Undertaking Application * APLA - Trade Finance Undertaking Application Issuance Advice * CANC - Trade Finance Undertaking Application Cancelled * EXPI - Trade Finance Undertaking Application Expired * RELE - Trade Finance Undertaking Application Released * RJCT - Trade Finance Undertaking Application Rejected * UNTN - Trade Finance Undertaking Termination Notice required: false style: form explode: false schema: type: string example: APLA examples: CreateBankGuaranteeEx-1: summary: Example-1 - Application for issuance of Guarantee value: platform_reference: e5d5adfc-4e60-46f6-a6c9-3a287aa6f39b applicant_issuance_request_identification: Corporate1 issuer_acknowledgement_identification: null undertaking_identification: null undertaking_application_date: '2020-01-01' third_party_issuance_request_identification: null issuance_date: null undertaking_status: APPL undertaking_form: DGAR issuance_type: ISCO undertaking_type: PERF undertaking_text_purpose: FINL undertaking_wording_type: STND undertaking_wording_narrative: null standard_wording_language: null party: - type: APPL identification: KONE654242 any_bic: null lei: null name: ABC Company, Ltd address_line: - ' 1 Austin Rd West' country: IE contact_name: ABC Company, Ltd contact_phone_number: +852-22221113 contact_email_address: contact@gmail.com - type: BENE identification: null any_bic: null lei: null name: XYZ Company, Ltd address_line: - 388 EMEA Street country: US contact_name: XYZ Company, Ltd contact_phone_number: +001-22221113 contact_email_address: contact@rediffmail.com - type: ISSU identification: CITIIE20 any_bic: CITIIE20 lei: null name: Citibank EMEA address_line: - 'Ireland street ' country: IE contact_name: Citibank EMEA contact_phone_number: +91-6787458215 contact_email_address: contact@citi.com undertaking_amount: currency: EUR amount: '30000' undertaking_amount_additional_information: null expiry_type: COND undertaking_expiry_date: null undertaking_expiry_condition: text purpose expiry_open_ended_indicator: 'N' confirmation_instructions: WITHOUT undertaking_terms_and_conditions: - STANDARD WORDING auto_extension_period: months: '24' auto_extension_notification_period: '15' auto_extension_non_extension_notification_narrative: null auto_extension_final_expiry_date: '2025-03-22' governance_rule_identification: URDG governance_rule_narrative: null applicable_law_or_jurisdiction: country: IN text: Mumbai, India underlying_transaction_additional_info: null presentation_instructions: >- We undersigned --- (bank) hereby irrevocably and unconditionally undertake to pay to yourselves or your order immediately and within 3 calendar days from receipt of your first demand by facsimile and/or letter signed by your President Director or Vice President Director or your authorized representative, any amount up to EUR 1.830.000,00 (say: Euro Dollar one million Eight hundred thirty thousand) notwithstanding any challenge whatsoever presentation_document: null presentation_medium: null presentation_representation: place_of_presentation: place: ADVP country: IN partial_demand_indicator: NMLT transfer_indicator: true transfer_conditions: null charge: - charge_type: COMM charges_payable_by: APPL charges_account: iban: AT611904300234573201 charge_amount: currency: EUR amount: '6545.56' delivery_channel_method: COUR deliver_to_party_type: BENE deliver_to_name: null deliver_to_address: null deliver_to_tracking_reference: DHLtrackingid965 deliver_to_electronic_details: null supporting_document: null instructions_to_bank: Dear Louise, please consider our bank guarantee application... application_advice_information: Everything validated. amendment_request_supporting_information: amendment_request_identification: null amendment_platform_reference: null amendment_sequence_number: null amendment_request_date: null amendment_date: null undertaking_amendment_instruction_purpose: null amendment_impact: null undertaking_termination_request: null undertaking_increase_decrease_amount: increase_amount: currency: null amount: null new_undertaking_terms_and_conditions: null counter_undertaking_increase_decrease_amount: increase_amount: currency: null amount: null new_counter_undertaking_terms_and_condition: null delivery_channel_method: null deliver_to_party_type: null deliver_to_name: null deliver_to_address: null deliver_to_tracking_reference: null reduction_release: undertaking_release_reduction_date: null undertaking_release_reduction_reason: null reduced_or_released_amount: currency: null amount: null outstanding_amount: currency: null amount: null account_with_bank: any_bic: null lei: null name: null address_line: null country: null supporting_document: - undertaking_document_type: null undertaking_document_identification: null undertaking_document_format: null file_name: null issue_date: null linked_url_address: null digital_signature: name: null digital_signature: null additional_information: null CreateBankGuaranteeEx-2: summary: Example-2 - Application for issuance of Guarantee value: platform_reference: e5d5adfc-4e60-46f6-a6c9-3a287aa6f39b applicant_issuance_request_identification: Corporate1 issuer_acknowledgement_identification: null undertaking_identification: null undertaking_application_date: '2020-01-01' third_party_issuance_request_identification: null issuance_date: null undertaking_status: APPL undertaking_form: DGAR issuance_type: ISCO undertaking_type: PERF undertaking_text_purpose: FINL undertaking_wording_type: STND undertaking_wording_narrative: null standard_wording_language: null party: - type: APPL identification: KONE654242 any_bic: null lei: null name: ABC Company, Ltd address_line: - ' 1 Austin Rd West' country: IE contact_name: ABC Company, Ltd contact_phone_number: +852-22221113 contact_email_address: contact@gmail.com - type: BENE identification: null any_bic: null lei: null name: XYZ Company, Ltd address_line: - 388 EMEA Street country: US contact_name: XYZ Company, Ltd contact_phone_number: +001-22221113 contact_email_address: contact@rediffmail.com - type: ISSU identification: CITIIE20 any_bic: CITIIE20 lei: null name: Citibank EMEA address_line: - 'Ireland street ' country: IE contact_name: Citibank EMEA contact_phone_number: +91-6787458215 contact_email_address: contact@citi.com undertaking_amount: currency: EUR amount: '30000' undertaking_amount_additional_information: null expiry_type: COND undertaking_expiry_date: null undertaking_expiry_condition: text purpose expiry_open_ended_indicator: 'N' confirmation_instructions: WITHOUT undertaking_terms_and_conditions: - STANDARD WORDING auto_extension_period: months: '24' auto_extension_notification_period: '15' auto_extension_non_extension_notification_narrative: null auto_extension_final_expiry_date: '2025-03-22' governance_rule_identification: URDG governance_rule_narrative: null applicable_law_or_jurisdiction: country: IN text: Mumbai, India underlying_transaction_additional_info: null presentation_instructions: >- We undersigned --- (bank) hereby irrevocably and unconditionally undertake to pay to yourselves or your order immediately and within 3 calendar days from receipt of your first demand by facsimile and/or letter signed by your President Director or Vice President Director or your authorized representative, any amount up to EUR 1.830.000,00 (say: Euro Dollar one million Eight hundred thirty thousand) notwithstanding any challenge whatsoever presentation_document: null presentation_medium: null presentation_representation: place_of_presentation: place: ADVP country: IN partial_demand_indicator: NMLT transfer_indicator: true transfer_conditions: null charge: - charge_type: COMM charges_payable_by: APPL charges_account: iban: AT611904300234573201 charge_amount: currency: EUR amount: '6545.56' delivery_channel_method: COUR deliver_to_party_type: BENE deliver_to_name: null deliver_to_address: null deliver_to_tracking_reference: DHLtrackingid965 deliver_to_electronic_details: null supporting_document: null instructions_to_bank: Dear Louise, please consider our bank guarantee application... application_advice_information: Everything validated. amendment_request_supporting_information: amendment_request_identification: null amendment_platform_reference: null amendment_sequence_number: null amendment_request_date: null amendment_date: null undertaking_amendment_instruction_purpose: null amendment_impact: null undertaking_termination_request: null undertaking_increase_decrease_amount: increase_amount: currency: null amount: null new_undertaking_terms_and_conditions: null counter_undertaking_increase_decrease_amount: increase_amount: currency: null amount: null new_counter_undertaking_terms_and_condition: null delivery_channel_method: null deliver_to_party_type: null deliver_to_name: null deliver_to_address: null deliver_to_tracking_reference: null reduction_release: undertaking_release_reduction_date: null undertaking_release_reduction_reason: null reduced_or_released_amount: currency: null amount: null outstanding_amount: currency: null amount: null account_with_bank: any_bic: null lei: null name: null address_line: null country: null supporting_document: - undertaking_document_type: null undertaking_document_identification: null undertaking_document_format: null file_name: null issue_date: null linked_url_address: null digital_signature: name: null digital_signature: null additional_information: null CreateBankGuaranteeEx-3: summary: Example-3 - Application for Issuance of Guarantee CreateBankGuaranteeEx-4: summary: Example-4 - *** Raw *** payload example value: applicant_issuance_request_identification: string issuer_acknowledgement_identification: string third_party_issuance_request_identification: string application_date: '4305-01-18' form_of_undertaking: DGAR undertaking_purpose: FINL issuance_type: stri undertaking_type: stri undertaking_text_purpose: DRAFT wording_of_undertaking_type: stri wording_of_undertaking_type_narrative: string language_of_standard_wording: cm party: - type: stri identification: string issuer: string any_bic: J9E7PS84BUA lei: ZC4CURB9P12G8A6SQC66 name: string address_line: - string country: VV contact_name: string contact_phone_number: +51--)478)02-+ contact_email_address: user@example.com additional_details: string undertaking_amount: currency: ESZ amount: '000311658165819.787' undertaking_amount_additional_information: string expiry_type: COND undertaking_expiry_date: 2020-05-31-01:19 undertaking_expiry_condition: string expiry_open_ended_indicator: true confirmation_instructions: CONFIRM undertaking_terms_and_conditions: - string auto_extension_period: days: 0 auto_extension_final_expiry_date: '8800-02-29' auto_extension_notification_period: 0 auto_extension_non_extension_notification_narrative: string governance_rule_identification: ISPR governance_rule_narrative: string applicable_law_or_jurisdiction: country: YK text: string underlying_transaction_additional_info: string presentation_instructions: string presentation_document: - wording: string electronic_details: - format: stri channel: stri address: string additional_details: string file_name: string presentation_medium: stri presentation_representation: place_of_presentation: place: stri country: FK partial_demand_indicator: NMLT transfer_indicator: true transfer_conditions: string charge: - charge_type: string charges_payable_by: stri charges_account: iban: WV741pfeEUhRJZWPkwNB0owhxnp4Rl charge_amount: currency: YAP amount: '0000000000000000000' delivery_channel_method: stri deliver_to_party_type: stri deliver_to_name: string deliver_to_address: - string deliver_to_tracking_reference: string deliver_to_electronic_details: - format: stri channel: stri address: string additional_details: string additional_deliver_to_details: string supporting_document: - undertaking_document_type: stri undertaking_document_identification: string undertaking_document_format: stri file_name: string issue_date: 6852-07-31-05:53 linked_url_address: null digital_signature: name: string digital_signature: string additional_details: string instructions_to_bank: string application_advice_information: string amendment_request_identification: string amendment_request_date: 4060-02-29Z date_of_amendment: 2439-08-19Z undertaking_termination_request: true undertaking_amendment_instruction_purpose: ICCA undertaking_increase_decrease_amount: increase_amount: currency: TQG amount: '0000000000000005854' undertaking_amendment_additional_information: - string counter_undertaking_increase_decrease_amount: increase_amount: currency: ASI amount: '0000000000000000000' counter_undertaking_amendment_additional_information: string undertaking_release_reduction_date: 5658-12-30-17:53 undertaking_release_reduction_reason: stri reduced_or_released_amount: currency: ZGA amount: '0000000000000000000' outstanding_amount: currency: JIY amount: '0000000000000000000' amount_additional_information: string account_with_bank: any_bic: 56A2PEADMVV lei: KBB7AJM5OV87D3D9OF75 name: string address_line: - string location: string country: XH additionalinformation: string GETBankGuaranteeResponseCollectionEx-1: summary: Example-1 - Get a list of bank guarantee application value: trade_finance_instruction: - application_reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 applicant_issuance_request_identification: XYZ999-123 issuer_acknowledgement_identification: BG24112022-Ack01 undertaking_identification: BG24112022-001 application_date: '2023-06-01' status: APLA form_of_undertaking: DGAR undertaking_purpose: DRFT party: - type: APPL identification: CUST1234 any_bic: SWHQBEBBXXX lei: D305FJ6O4MJ1JYQHT200 name: ' High Fidelity Components, Ltd' address_line: - ' 1 Austin Rd West' country: HK contact_name: Max T contact_phone_number: 1 contact_email_address: contact@citi.com undertaking_amount: currency: EUR amount: '30000' expiry_type: COND undertaking_expiry_date: '2024-03-22' expiry_open_ended_indicator: false confirmation_instructions: WITHOUT undertaking_terms_and_conditions: - STANDARD WORDING auto_extension_period: days: 10 auto_extension_final_expiry_date: '2025-03-22' auto_extension_notification_period: 30 governance_rule_identification: URDG applicable_law_or_jurisdiction: country: IN text: Mumbai, India presentation_instructions: >- We undersigned --- (bank) hereby irrevocably and unconditionally undertake to pay to yourselves or your order immediately and within 3 calendar days from receipt of your first demand by facsimile and/or letter signed by your President Director or Vice President Director or your authorized representative, any amount up to EUR 1.830.000,00 (say: Euro Dollar one million Eight hundred thirty thousand) notwithstanding any challenge whatsoever presentation_document: - wording: Wording for commercial invoice document. electronic_details: - format: DPDF channel: EMAL address: contact@citi.com presentation_medium: ELEC presentation_representation: place_of_presentation: place: ADVP country: IN partial_demand_indicator: NMLT transfer_indicator: true charge: - charge_type: COMM charges_payable_by: APPL charges_account: iban: AT611904300234573201 charge_amount: currency: EUR amount: '6545.56' delivery_channel_method: COUR deliver_to_party_type: ISSU deliver_to_name: Max T deliver_to_address: - ' 1 Austin Rd West' deliver_to_tracking_reference: DHLtrackingid965 deliver_to_electronic_details: - format: DPDF channel: EMAL address: contact@citi.com supporting_document: - undertaking_document_type: CINV undertaking_document_identification: '123456891' undertaking_document_format: DPDF file_name: INV20221110 issue_date: '2023-11-23' linked_url_address: null digital_signature: name: ' High Fidelity Components, Ltd' digital_signature: X instructions_to_bank: Dear Louise, please consider our bank guarantee application... application_advice_information: Everything validated. amendment_request_identification: BGAMDREQ2022-001 amendment_request_date: '2023-11-22' date_of_amendment: '2024-04-20' undertaking_termination_request: false undertaking_amendment_instruction_purpose: ICCA undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' undertaking_amendment_additional_information: - Information related to the amendment counter_undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' counter_undertaking_amendment_additional_information: Information related to counter undertaking amendment undertaking_release_reduction_date: '2024-04-22' undertaking_release_reduction_reason: BUFI reduced_or_released_amount: currency: EUR amount: '1000' outstanding_amount: currency: EUR amount: '2310' account_with_bank: any_bic: SWHQBEBBXXX lei: UIYHHVRQ9T1BLO84ZW44 name: ' High Fidelity Components, Ltd' address_line: - ' 1 Austin Rd West' country: HK additionalinformation: Additional information related to the termination. - application_reference: 123e456-e89b-12d3-a456-426614174000 applicant_issuance_request_identification: TEST15022026 issuer_acknowledgement_identification: string undertaking_identification: 34567AC2-002 status: APLA application_date: '2020-01-01' form_of_undertaking: DGAR undertaking_purpose: FINL party: - type: APPL name: Pumpen AG address_line: - 60599 Frankfurt country: DE - type: BENE name: Mining Ltd. address_line: - Main Road - Oslo country: 'NO' - type: ISSU any_bic: BOGEDEFFXXX undertaking_amount: currency: EUR amount: '50000.00' expiry_type: FIXD undertaking_expiry_date: '2020-12-31' undertaking_terms_and_conditions: - >- We have been informed that you, Mining PLC, Main Road, Oslo NORWAY, hereinafter called the BUYER have concluded the contract No. ABC123 of 05th February 2020, hereinafter called the CONTRACT, with Pumpen AG, Postfach 123, 60599 Frankfurt, GERMANY, hereinafter called the SELLER, according to which the SELLER will deliver to the BUYER pumps and equipment, in the total value of EUR 500.000,00. governance_rule_identification: NONE supporting_document: - undertaking_document_type: CINV undertaking_document_identification: /PO/5000/5010/5700016010 - undertaking_document_type: ECID undertaking_document_identification: IN-RJ08067329916487V issue_date: '2023-03-20' additionalinformation: string GETBankGuaranteeResponseCollectionEx-2: summary: Example-2 - No record found value: trade_finance_instruction: [] GETBankGuaranteeResponseCollectionEx-3: summary: Example-3 - *** Raw *** payload example value: trade_finance_instruction: - application_reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 applicant_issuance_request_identification: string issuer_acknowledgement_identification: string undertaking_identification: string third_party_issuance_request_identification: string application_date: '8800-02-29' issuance_date: 7200-02-29Z status: AMRQ form_of_undertaking: DEPU undertaking_purpose: DRFT issuance_type: stri undertaking_type: stri undertaking_text_purpose: DRAFT wording_of_undertaking_type: stri wording_of_undertaking_type_narrative: string language_of_standard_wording: ji party: - type: stri identification: string issuer: string any_bic: 07SKTBSJEQK lei: MURTTH7OW2KMJMMXXS00 name: string address_line: - string country: YJ contact_name: string contact_phone_number: +9-7-472281((215-4()664+2--1(8 contact_email_address: user@example.com additional_details: string undertaking_amount: currency: PEK amount: '0000000000000000000' undertaking_amount_additional_information: string expiry_type: COND undertaking_expiry_date: 6352-11-30Z undertaking_expiry_condition: string expiry_open_ended_indicator: true confirmation_instructions: CONFIRM undertaking_terms_and_conditions: - string auto_extension_period: days: 0 auto_extension_final_expiry_date: 9200-02-29+15:21 auto_extension_notification_period: 0 auto_extension_non_extension_notification_narrative: string governance_rule_identification: ISPR governance_rule_narrative: string applicable_law_or_jurisdiction: country: GY text: string underlying_transaction_additional_info: string presentation_instructions: string presentation_document: - wording: string electronic_details: - format: stri channel: stri address: string additional_details: string file_name: string presentation_medium: stri presentation_representation: place_of_presentation: place: stri country: OS partial_demand_indicator: NMLT transfer_indicator: true transfer_conditions: string charge: - charge_type: string charges_payable_by: stri charges_account: iban: VN431Xt1Au3v6Fme8ivyrO charge_amount: currency: DRH amount: '0000000000000000000' delivery_channel_method: stri deliver_to_party_type: stri deliver_to_name: string deliver_to_address: - string deliver_to_tracking_reference: string deliver_to_electronic_details: - format: stri channel: stri address: string additional_details: string additional_deliver_to_details: string supporting_document: - undertaking_document_type: stri undertaking_document_identification: string undertaking_document_format: stri file_name: string issue_date: '4921-10-31' linked_url_address: string digital_signature: name: string digital_signature: string additional_details: string instructions_to_bank: string application_advice_information: string amendment_request_identification: string amendment_request_date: '6517-12-29' date_of_amendment: '6804-02-29' undertaking_termination_request: true undertaking_amendment_instruction_purpose: ICCA undertaking_increase_decrease_amount: increase_amount: currency: JWQ amount: '0000000000000000000' undertaking_amendment_additional_information: - string counter_undertaking_increase_decrease_amount: increase_amount: currency: JZZ amount: '0000000000000000000' counter_undertaking_amendment_additional_information: string undertaking_release_reduction_date: '3600-02-29' undertaking_release_reduction_reason: stri reduced_or_released_amount: currency: HYZ amount: '0000000000000000000' outstanding_amount: currency: YJG amount: '0000000000000000000' amount_additional_information: string account_with_bank: any_bic: ZG6GLPJFG1T lei: SC5ZV4XNEZ0GPIZFNY16 name: string address_line: - string location: string country: SA additionalinformation: string links: - href: string rel: string type: string GETBankGuaranteeResponseEx-1: summary: Example-1 - Get a bank guarantee application by Id value: application_reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 applicant_issuance_request_identification: XYZ999-123 issuer_acknowledgement_identification: BG24112022-Ack01 undertaking_identification: BG24112022-001 application_date: '2020-01-01' status: APLA form_of_undertaking: DGAR undertaking_purpose: DRFT party: - type: APPL identification: CUST1234 issuer: string any_bic: SWHQBEBBXXX lei: D305FJ6O4MJ1JYQHT200 name: ' High Fidelity Components, Ltd' address_line: - 1 Austin Rd West country: HK contact_name: Max T contact_phone_number: +852-22221113 contact_email_address: contact@citi.com undertaking_amount: currency: EUR amount: '30000' undertaking_expiry_date: '2024-03-22' undertaking_terms_and_conditions: - STANDARD WORDING auto_extension_final_expiry_date: '2025-03-22' governance_rule_identification: URDG applicable_law_or_jurisdiction: country: IN text: Mumbai, India underlying_transaction_additional_info: string presentation_instructions: >- We undersigned --- (bank) hereby irrevocably and unconditionally undertake to pay to yourselves or your order immediately and within 3 calendar days from receipt of your first demand by facsimile and/or letter signed by your President Director or Vice President Director or your authorized representative, any amount up to EUR 1.830.000,00 (say: Euro Dollar one million Eight hundred thirty thousand) notwithstanding any challenge whatsoever presentation_document: - wording: string electronic_details: - format: DPDF channel: EMAL address: contact@citi.com presentation_medium: ELEC presentation_representation: place_of_presentation: place: ADVP country: IN charge: - charge_type: COMM charges_payable_by: APPL charges_account: iban: AT611904300234573201 charge_amount: currency: EUR amount: '6545.56' delivery_channel_method: COUR deliver_to_party_type: ISSU deliver_to_name: Max T deliver_to_address: - 1 Austin Rd West deliver_to_tracking_reference: DHLtrackingid965 deliver_to_electronic_details: - format: DPDF channel: EMAL address: contact@citi.com supporting_document: - undertaking_document_type: CINV undertaking_document_identification: '123456891' undertaking_document_format: DPDF file_name: INV20221110 issue_date: '2023-11-23' linked_url_address: null instructions_to_bank: Dear Louise, please consider our bank guarantee application... application_advice_information: Everything validated. amendment_request_identification: BGAMDREQ2022-001 amendment_request_date: '2023-11-22' date_of_amendment: '2024-04-20' undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' undertaking_amendment_additional_information: - Information related to the amendment counter_undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' counter_undertaking_amendment_additional_information: Information related to counter undertaking amendment undertaking_release_reduction_date: '2024-04-22' undertaking_release_reduction_reason: BUFI reduced_or_released_amount: currency: EUR amount: '1000' outstanding_amount: currency: EUR amount: '2310' account_with_bank: any_bic: SWHQBEBBXXX lei: UIYHHVRQ9T1BLO84ZW44 name: ' High Fidelity Components, Ltd' address_line: - 1 Austin Rd West country: HK additionalinformation: string GETBankGuaranteeResponseEx-2: summary: Example-2 - Get a bank guarantee application by Id value: application_reference: 123e456-e89b-12d3-a456-426614174000 applicant_issuance_request_identification: TEST15022026 undertaking_identification: 34567AC2-002 application_date: '2020-01-01' issuance_date: '2020-05-06' status: APPL form_of_undertaking: DGAR undertaking_purpose: FINL party: - type: APPL name: Pumpen AG address_line: - 60599 Frankfurt country: DE - type: BENE name: Mining Ltd. address_line: - Main Road - Oslo country: 'NO' - type: ISSU any_bic: BOGEDEFFXXX undertaking_amount: currency: EUR amount: '50000.00' expiry_type: FIXD undertaking_expiry_date: '2020-12-31' undertaking_terms_and_conditions: - >- We have been informed that you, Mining PLC, Main Road, Oslo NORWAY, hereinafter called the BUYER have concluded the contract No. ABC123 of 05th February 2020, hereinafter called the CONTRACT, with Pumpen AG, Postfach 123, 60599 Frankfurt, GERMANY, hereinafter called the SELLER, according to which the SELLER will deliver to the BUYER pumps and equipment, in the total value of EUR 500.000,00. governance_rule_identification: NONE supporting_document: - undertaking_document_type: CINV undertaking_document_identification: /PO/5000/5010/5700016010 - undertaking_document_type: ECID undertaking_document_identification: IN-RJ08067329916487V issue_date: '2023-03-20' additionalinformation: string GETBankGuaranteeResponseEx-3: summary: Example-3 - Get a bank guarantee application by Id value: application_reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 applicant_issuance_request_identification: 0003NALC0001624 undertaking_identification: BIUGIUBOBD98 application_date: '2023-01-02' issuance_date: '2023-01-13' status: APPL form_of_undertaking: DGAR undertaking_purpose: DRFT party: - type: APPL any_bic: ICICINBIXXX name: ICICI BANK LIMITED address_line: - India country: IN - type: BENE any_bic: GAIIINDIXXX undertaking_amount: currency: INR amount: '10000.00' undertaking_expiry_date: '2023-06-16' undertaking_terms_and_conditions: - >- THIS BANK GUARANTEE IS MADE ON BY HEREINAFTER REFERRED TO AS THE GUARANTOR WHICH EXPRESSION SHALL UNLESS REPUGNANT TO THE CONTEXT OR MEANING THEREOF SHALL MEAN AND INCLUDE ITS PERMITTED ASSIGNS AND SUCCESSORS IN FAVOUR OF BENE INDIA LIMITED HEREINAFTER REFERRED AS SELLER A COMPANY HAVING ITS REGISTERED OFFICE IS AT WHICH EXPRESSION UNLESS IT IS REPUGNANT TO THE CONTEXT OR MEANING THEREOF SHALL MEAN AND INCLUDE ITS SUCCESSORS, ADMINISTRATORS, ASSIGNS AND EXECUTORS. CUSTOMER NAME HEREINAFTER REFERRED TO AS BUYER, HAVING ITS REGISTERED OFFICE PLACE OF BUSINESS AT WHICH EXPRESSION SHALL UNLESS REPUGNANT TO THE CONTEXT OR MEANING THEREOF SHALL MEAN AND INCLUDE THEIR PERMITTED ASSIGNS AND SUCCESSORS) HAVE ENTERED INTO NAME OF CONTRACTS/AGREEMENTS TO BE MENTIONED DATED HEREINAFTER REFERRED AS CONTRACT WITH SELLER FOR SUPPLY TRANSPORTATION OF GAS AND WHEREAS IN TERMS OF CONTRACT, BUYER HAS AGREED TO FURNISH ON DEMAND, UNCONDITIONAL, IRREVOCABLE BANK GUARANTEE FOR AN AMOUNT OF RS/-150000000 (RUPEES ONLY) DURING THE TERMS OF THE CONTRACT. WHEREAS THIS GUARANTEE IS BEING FURNISHED TO GUARANTEE THE NON-PAYMENT BY BUYER OF ANY PAYMENTS DUE TO SELLER UNDER THE CONTRACT. GUARANTEE NOW THEREFORE WE, BANK, DO HEREBY ON DEMAND, UNCONDITIONALLY AND IRREVOCABLY GUARANTEE THE NON-PAYMENT BY BUYER OF ANY PAYMENTS DUE AND PAYABLE TO SELLER WITHOUT ANY RECOURSE TO THE BUYER UP TO A TOTAL OF RS /- 150000000(RUPEES ONLY AND UNDERTAKE TO PAY SELLER WITHOUT ANY CAVEAT OR RESERVATION OR PROTEST OR DEMUR OR RECOURSE OR ARGUMENT OR DELAY, ANY UNPAID AMOUNTS OF ANY OF THE DOCUMENTS SUCH AS INVOICES/PROVISIONAL INVOICES/DEBIT NOTES/STATEMENT OF CLAIM/ DEMAND LETTER /CLAIM LETTER ETC. RAISED UNDER THE AFORESAID CONTRACT, MOPANDNG DIRECTIONS INCLUDING ANY STATUTORY AUTHORITIES AS WELL AS SUPPLEMENTARY AGREEMENTS, SIDE LETTERS, TERM SHEET, AMENDMENTS ETC. AND OTHER ADDENDA THEREOF BY SELLER ON BUYER ON RECEIPT OF DEMAND FROM SELLER. ANY SUCH DEMAND MADE BY SELLER, SHALL BE CONCLUSIVE AND BINDING ON US IRRESPECTIVE OF ANY DISPUTE OR DIFFERENCE RAISED BY THE BUYER. 2. UNDERTAKING TO PAY A)WE BG ISSUING BANK HEREBY IRREVOCABLY AND UNCONDITIONALLY UNDERTAKE TO PAY ALL AMOUNTS DRAWN UPON THIS GUARANTEE. B) WE BG ISSUING BANK AGREE THAT MULTIPLE AND PARTIAL DRAWINGS UNDER THIS GUARANTEE ARE PERMITTED, SUBJECT TO THE LIMITS OF THIS GUARANTEE. C) WE BG ISSUING BANK AGREE THAT THE DEMAND AS SPECIFIED IN CLAUSE 1 ABOVE SHALL BE FINAL, CONCLUSIVE AND BINDING ON US. D) WE BG ISSUING BANK UNDERTAKE NOT TO REVOKE THIS GUARANTEE DURING ITS CURRENCY WITHOUT PREVIOUS WRITTEN CONSENT OF SELLER AND FURTHER AGREE THAT THE GUARANTEE CONTAINED HEREIN SHALL CONTINUE TO BE ENFORCEABLE TILL THE SELLER DISCHARGES THIS GUARANTEE. 3.WE FURTHER AGREE AS FOLLOWS A)PAYMENTS UNDER THIS GUARANTEE TO SELLER SHALL BE MADE IN FULL WITHOUT ANY SET OFF OR COUNTER CLAIM AND FREE AND CLEAR OF AND WITHOUT DEDUCTION OR WITHHOLDING ANY PRESENT OR FUTURE TAXES, DUTIES, ANY / OR OTHER CHARGES. B)PAYMENT OF AN AMOUNT UNDER THIS GUARANTEE SHALL BE MADE IMMEDIATELY ON DEMAND AND SHOULD WE FAIL TO RELEASE PAYMENT ON DEMAND, INTEREST AT BASE RATE LUS 6.25 PERCENT PER ANNUM SHALL BECOME PAYABLE FROM DATE OF DEMAND TILL THE DATE OF ACTUAL PAYMENT. C)SELLER SHALL HAVE FULLEST LIBERTY WITHOUT OUR CONSENT AND WITHOUT AFFECTING IN ANY MANNER OUR OBLIGATIONS HEREUNDER, TO VARY ANY OF THE TERMS AND CONDITIONS OF THE CONTRACT TO EXTEND TIME FOR PERFORMANCE BY BUYER FROM TIME TO TIME OR POSTPONE FOR ANY TIME OR FROM TIME TO TIME ANY OF THE POWERS EXERCISABLE BY SELLER AGAINST BUYER. D)SELLER SHALL BE ENTITLED TO ENFORCE TO WAIVE OR FORBEAR ANY OF THE TERMS AND CONDITIONS RELATING TO THE CONTRACT AND WE SHALL NOT BE RELIEVED FROM OUR LIABILITY BY ANY REASON OR ANY VARIATION, OR EXTENSION BEING GRANTED TO BUYER OR FOR WAIVER, ACT OR OMISSION ON THE PART OF SELLER OR ANY INDULGENCE BY SELLER TO BUYER BY ANY SUCH MATTER OR THING WHATSOEVER WHICH UNDER THE LAW RELATING TO THE SURETIES WOULD BUT FOR THIS PROVISION HAVE EFFECT OF SO RELIEVING US. E)SELLER HAS A RIGHT TO STOP SUPPLY/TRANSMISSION OF GAS TO THE BUYER WHICH SHALL NOT AFFECT THE GUARANTORS OBLIGATIONS UNDER THIS GUARANTEE. F)WE HEREBY WAIVE ANY AND ALL SUBROGATION RIGHTS ARISING IN TERMS OF THIS GUARANTEE AGAINST BUYER UNTIL ALL PAYMENTS DUE AND OWING TO SELLER UNDER THE CONTRACT HAVE BEEN PAID BY BUYER. G)THIS GUARANTEE SHALL BE IRREVOCABLE AND SHALL REMAIN VALID UP TO. WITH A CLAIM PERIOD OF TWO MONTHS UP TO. IF AT LEAST FIFTEEN (15) DAYS PRIOR TO THE EXPIRY OF THIS GUARANTEE, BUYER FAILS TO REPLACE OR RENEW SUCH BANK GUARANTEE WITH ANOTHER BANK GUARANTEE AS ACCEPTABLE TO THE SELLER THEN SELLER SHALL HAVE THE RIGHT TO DRAW ON THE BALANCE AMOUNT OF SUCH GUARANTEE BEFORE IT EXPIRES. SUCH AMOUNT RECEIVED BY THE SELLER, WOULD BE TREATED AS A DEPOSIT QUA PAYMENTS/RECEIVABLES TOWARDS GAS SUPPLIES/TRANSMISSION. H)THE GUARANTEE SHALL NOT BE AFFECTED BY ANY LEGAL LIMITATION, DISABILITY OR OTHER CIRCUMSTANCES RELATING TO BUYER OR THE GUARANTOR OR ANY APPOINTMENT OF RECEIVER, LIQUIDATOR, ADMINISTRATOR OF ASSETS, INSOLVENCY, BANKRUPTCY OR WINDING UP, AMALGAMATION, RE-ORGANISATION OR RESTRUCTURING OF BUYER OR ANY PENDING LEGAL PROCEEDINGS OR DISPUTE BETWEEN THE PARTIES PENDING BEFORE ANY OFFICER, TRIBUNAL OR COURT. I)THE OFFICER SIGNING THIS GUARANTEE IS AUTHORISED FOR THIS PURPOSE AND SHALL REMAIN BINDING UPON THE BANK. J)ANY DISPUTE ARISING OUT OF OR IN RELATION TO THE SAID GUARANTEE SHALL BE GOVERNED BY AND SUBJECT TO THE EXCLUSIVE JURISDICTION OF DELHI COURTS. 4.NOTWITHSTANDING ANY CONTAINED HEREIN 1.OUR LIABILITY UNDER THIS BANK GUARANTEE SHALL NOT EXCEED RS/-150000000 (RUPEES ONLY). 2.THIS BANK GUARANTEE SHALL BE VALID UP TO WITH A CLAIM PERIOD OF TWO MONTHS UP TO 3.WE ARE LIABLE TO PAY THE GUARANTEED AMOUNT OR ANY PART THEREOF UNDER THIS BANK GUARANTEE IF AND ONLY, IF YOU SERVE UPON US A WRITTEN CLAIM OR DEMAND ON OR BEFORE. governance_rule_identification: URDG supporting_document: - undertaking_document_type: CINV undertaking_document_identification: PO/6789/9876/ 736482988 GETBankGuaranteeResponseEx-4: summary: Example-4 - *** Raw *** payload example value: application_reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 applicant_issuance_request_identification: string issuer_acknowledgement_identification: string undertaking_identification: string third_party_issuance_request_identification: string application_date: '4400-02-29' issuance_date: 2740-02-29Z status: AMRQ form_of_undertaking: DEPU undertaking_purpose: DRFT issuance_type: stri undertaking_type: stri undertaking_text_purpose: DRAFT wording_of_undertaking_type: stri wording_of_undertaking_type_narrative: string language_of_standard_wording: vp party: - type: stri identification: string issuer: string any_bic: UPAHGAL3 lei: YOLKO86DF7Q49V8XPM90 name: string address_line: - string country: IQ contact_name: string contact_phone_number: +20-970 contact_email_address: user@example.com additional_details: string undertaking_amount: currency: OGY amount: '0000.' undertaking_amount_additional_information: string expiry_type: COND undertaking_expiry_date: '4725-01-31' undertaking_expiry_condition: string expiry_open_ended_indicator: true confirmation_instructions: CONFIRM undertaking_terms_and_conditions: - string auto_extension_period: days: 0 auto_extension_final_expiry_date: '1121-07-31' auto_extension_notification_period: 0 auto_extension_non_extension_notification_narrative: string governance_rule_identification: ISPR governance_rule_narrative: string applicable_law_or_jurisdiction: country: DU text: string underlying_transaction_additional_info: string presentation_instructions: string presentation_document: - wording: string electronic_details: - format: stri channel: stri address: string additional_details: string file_name: string presentation_medium: stri presentation_representation: place_of_presentation: place: stri country: KG partial_demand_indicator: NMLT transfer_indicator: true transfer_conditions: string charge: - charge_type: string charges_payable_by: stri charges_account: iban: IY03I3X charge_amount: currency: FLE amount: '0000000000000000000' delivery_channel_method: stri deliver_to_party_type: stri deliver_to_name: string deliver_to_address: - string deliver_to_tracking_reference: string deliver_to_electronic_details: - format: stri channel: stri address: string additional_details: string additional_deliver_to_details: string supporting_document: - undertaking_document_type: stri undertaking_document_identification: string undertaking_document_format: stri file_name: string issue_date: 5460-02-29-05:42 linked_url_address: string digital_signature: name: string digital_signature: string additional_details: string instructions_to_bank: string application_advice_information: string amendment_request_identification: string amendment_request_date: '1600-02-29' date_of_amendment: 9200-02-29Z undertaking_termination_request: true undertaking_amendment_instruction_purpose: ICCA undertaking_increase_decrease_amount: increase_amount: currency: JRO amount: '0000000000004881265' undertaking_amendment_additional_information: - string counter_undertaking_increase_decrease_amount: increase_amount: currency: UOW amount: '0000000000000000000' counter_undertaking_amendment_additional_information: string undertaking_release_reduction_date: 8676-02-29-12:50 undertaking_release_reduction_reason: stri reduced_or_released_amount: currency: PXP amount: '0000000000000000000' outstanding_amount: currency: AZW amount: '0000000000000000000' amount_additional_information: string account_with_bank: any_bic: KCHPMA53 lei: D1SH829ECYO9U09TSP13 name: string address_line: - string location: string country: TO additionalinformation: string ReplaceBankGuarantee: summary: Request to replace applied Bank Guarantee value: applicant_issuance_request_identification: XYZ999-123 issuer_acknowledgement_identification: BG24112022-Ack01 application_date: '2020-01-01' form_of_undertaking: DGAR undertaking_purpose: FINL party: - type: APPL identification: CUST1234 any_bic: SWHQBEBBXXX lei: D305FJ6O4MJ1JYQHT200 name: ' High Fidelity Components, Ltd' address_line: - ' 1 Austin Rd West' country: HK contact_name: Max T contact_phone_number: +852-22221113 contact_email_address: contact@citi.com undertaking_amount: currency: EUR amount: '30000' expiry_type: COND undertaking_expiry_date: '2024-03-22' expiry_open_ended_indicator: false confirmation_instructions: WITHOUT undertaking_terms_and_conditions: - STANDARD WORDING auto_extension_period: days: 10 auto_extension_final_expiry_date: '2025-03-22' auto_extension_notification_period: 30 governance_rule_identification: URDG applicable_law_or_jurisdiction: country: IN text: Mumbai, India presentation_instructions: >- We undersigned --- (bank) hereby irrevocably and unconditionally undertake to pay to yourselves or your order immediately and within 3 calendar days from receipt of your first demand by facsimile and/or letter signed by your President Director or Vice President Director or your authorized representative, any amount up to EUR 1.830.000,00 (say: Euro Dollar one million Eight hundred thirty thousand) notwithstanding any challenge whatsoever presentation_document: - wording: Wording for commercial invoice document. electronic_details: - format: DPDF channel: EMAL address: contact@citi.com presentation_medium: ELEC presentation_representation: place_of_presentation: place: ADVP country: IN partial_demand_indicator: NMLT transfer_indicator: true charge: - charge_type: COMM charges_payable_by: APPL charges_account: iban: AT611904300234573201 charge_amount: currency: EUR amount: '6545.56' delivery_channel_method: COUR deliver_to_party_type: ISSU deliver_to_name: Max T deliver_to_address: - ' 1 Austin Rd West' deliver_to_tracking_reference: DHLtrackingid965 deliver_to_electronic_details: - format: DPDF channel: EMAL address: contact@citi.com supporting_document: - undertaking_document_type: CINV undertaking_document_identification: '123456891' undertaking_document_format: DPDF file_name: INV20221110 issue_date: '2023-11-23' linked_url_address: null digital_signature: name: ' High Fidelity Components, Ltd' digital_signature: X instructions_to_bank: Dear Louise, please consider our bank guarantee application... application_advice_information: Everything validated. amendment_request_identification: BGAMDREQ2022-001 amendment_request_date: '2023-11-22' date_of_amendment: '2024-04-20' undertaking_termination_request: false undertaking_amendment_instruction_purpose: ICCA undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' undertaking_amendment_additional_information: - Information related to the amendment counter_undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' counter_undertaking_amendment_additional_information: Information related to counter undertaking amendment undertaking_release_reduction_date: '2024-04-22' undertaking_release_reduction_reason: BUFI reduced_or_released_amount: currency: EUR amount: '1000' outstanding_amount: currency: EUR amount: '2310' account_with_bank: any_bic: SWHQBEBBXXX lei: UIYHHVRQ9T1BLO84ZW44 name: ' High Fidelity Components, Ltd' address_line: - ' 1 Austin Rd West' country: HK additionalinformation: Additional information related to the termination. UpdateBankGuarantee: summary: Example-1 - Request to update a issued Bank Guarantee value: platform_reference: null applicant_issuance_request_identification: BGREQ24112022 issuer_acknowledgement_identification: null undertaking_identification: '5000052001' third_party_issuance_request_identification: null undertaking_form: null undertaking_application_date: '2023-01-03' issuance_type: null undertaking_status: AMRQ undertaking_type: '' undertaking_text_purpose: '' undertaking_wording_type: '' standard_wording_language: '' party: - type: APPL identification: CUST1234 any_bic: SWHQBEBBXXX name: ' High Fidelity Components, Ltd' address_line: - 1 Austin Rd West country: HK contact_name: Mukta Tom contact_phone_number: +001-85222221113 contact_email_address: dummy@citi.com - type: BENE identification: null any_bic: null lei: null name: XYZ Company, Ltd address_line: - 388 EMEA Street country: US contact_name: XYZ Company, Ltd contact_phone_number: +001-22221113 contact_email_address: contact@rediffmail.com undertaking_amount: currency: USD amount: '30000.00' expiry_type: COND undertaking_expiry_date: '2026-03-20' confirmation_instructions: null undertaking_terms_and_conditions: - N/A liability_account: iban: null auto_extension_period: days: '35' auto_extension_final_expiry_date: '2025-03-20' auto_extension_notification_period: '30' governance_rule_identification: null applicable_law_or_jurisdiction: country: null narrative: null underlying_transaction_amount: currency: null amount: null underlying_transaction_amount_percentage: null presentation_instructions: null presentation_document: - wording: Wording for commercial invoice document electronic_details: - format: DPDF channel: EMAL address: dummy@citi.com file_name: INV20221110 presentation_medium: ELEC presentation_representation: place_of_presentation: place: ADVP country: IN partial_demand: NMPT transfer_indicator: false charge: - charges_payable_by: APPL charges_account: iban: AT611904300234573201 charge_amount: currency: EUR amount: '6545.56' delivery_channel_method: COUR deliver_to_party_type: ISSU deliver_to_name: Tom Kadam deliver_to_tracking_reference: DHLtrackingid123 deliver_to_electronic_details: - format: DPDF channel: EMAL address: dummy@citi.com supporting_document: - undertaking_document_type: CINV undertaking_document_identification: '123456891' undertaking_document_format: DPDF file_name: INV20221110 issue_date: '2022-11-22' linked_url_address: '' digital_signature: name: ' High Fidelity Components, Ltd' digital_signature: WVQBkxo"6&L instructions_to_bank: Dear Louise, please consider our bank guarantee application... application_advice_information: Everything validated. amendment_request_supporting_information: amendment_request_identification: BGAMDREQ2022-001 amendment_platform_reference: 3fa85f64-5717-4562-b3fc-2c963f66afa6 amendment_sequence_number: '001' amendment_request_date: '2025-11-22' amendment_date: '2023-04-20' undertaking_amendment_instruction_purpose: ISCA amendment_impact: - CUAD undertaking_termination_request: false undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' new_undertaking_terms_and_conditions: - Information related to the amendment counter_undertaking_increase_decrease_amount: increase_amount: currency: EUR amount: '6545.56' new_counter_undertaking_terms_and_condition: Information related to counter undertaking amendment delivery_channel_method: COUR deliver_to_party_type: ISSU deliver_to_name: Louise TD deliver_to_address: - ABC Lane deliver_to_tracking_reference: DHLtrackingid123 reduction_release: undertaking_release_reduction_date: '2023-04-22' undertaking_release_reduction_reason: BUFI reduced_or_released_amount: currency: USD amount: '5000.00' outstanding_amount: currency: USD amount: '25000.00' account_with_bank: any_bic: SWHQBEBBXXX lei: QG18SURWG4MGQJSV7N86 name: ' High Fidelity Components, Ltd' address_line: - 1 Austin Rd West country: HK supporting_document: - undertaking_document_type: CINV undertaking_document_identification: '123456891' undertaking_document_format: DPDF file_name: INV20221110 issue_date: '2022-11-22' linked_url_address: '' digital_signature: name: ' High Fidelity Components, Ltd.' digital_signature: kUI5,hV2AWZeHo77 EJ163kDxbpO41S3?Xvv? additional_information: Dear account manager,. ... headers: Location: description: >- The Location response header containing the URI to the newly created resource. style: simple explode: false schema: type: string format: uri example: null X-Request-ID: description: >- Specify an unique end to end tracking request ID. The element will be populated by the API gateway style: simple explode: false schema: type: string ETag: description: >- An entity-tag, as defined in the RFC7232 ETag header field is an opaque identifier for the current versions of a resource. The subsequent PATCH/PUT requests should provide the ETag value in a If-match header field to implement optimistic concurrency control. If the server ETag value does not match with the provided ETag value, the error response 412 - precondition fail will be returned. This signifies the resource out of date. required: false style: simple explode: false schema: type: string example: f88dd058fe004909615a64f01be66a7 securitySchemes: oauthBearerToken: type: http description: The access token obtained as a result of OAuth 2.0 flows. scheme: bearer bearerFormat: opaque OAuth 2.0 oAuth2: type: oauth2 description: > This API uses OAuth2 with the client credentials grant type for service provider API gateway integration. flows: clientCredentials: tokenUrl: /v1/oauth2/token scopes: {}