openapi: 3.0.1 info: title: WorldLink description: >- WorldLink is a complete cross-border payment and Foreign-Exchange (FX) service that allows you to perform payments in 135 currencies without having the need to maintain local currency accounts for each of them. The CitiConnect WorldLink API now offers FX rate inquiry, FX deal booking, and cross-border payment initiation with 24X7 availability. Authentication for the CitiConnect WorldLink API services is based on the OAuth 2.0 standard. You can learn more about it in the **Authentication** section above. The generated OAuth token is valid for one hour after which you will have to request generation of a new OAuth token. **A note on 24X7 availability of the CitiConnect API Services** Although Citi strives to make all APIs 24X7 available wherever possible, there may still be downtimes albeit at a much reduced frequency and with shortened windows. Citi's Service representatives will send information about any near-term planned downtimes 3-4 business days in advance valid email so that you can plan your business activities related to your API interface to minimize any possible impact to your business and customers. Download our SDKs: * [Python SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=python&apiTitle=all&isClientSecReq=true) * [Java SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=java&apiTitle=all&isClientSecReq=true) * [.Net SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=dotnet&apiTitle=all&isClientSecReq=true) * [Ruby SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=ruby&apiTitle=all&isClientSecReq=true) * [NodeJS SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=nodejs&apiTitle=all&isClientSecReq=true) * [Go SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=go&apiTitle=all&isClientSecReq=true) * [CLI Tool SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=ccapi-cli&apiTitle=all&isClientSecReq=true) contact: name: Standards & Developer Hub url: https://tts.sandbox.developer.citi.com/citiconnect/ email: developer-support@citi.com version: 2.0.0 servers: - url: https://tts.apib2b.citi.com/citiconnect/prod/worldlinkservices description: production gateway url - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/worldlinkservices description: sandbox url tags: - name: WorldLink v2 security: - clientCredentials: [] paths: /v2/doddfrank/disclosure: post: tags: - WorldLink v2 summary: WorldLink Dodd Frank description: >- CitiConnect WorldLink Dodd Frank allows users to access information for fees, taxes, and delivery dates. This information is subsequently provided to consumers on a Dodd Frank 1073 disclosure or receipt. operationId: doddFrankRequestUsingPOST parameters: - name: client_id in: query description: Unique identifier which is created during the onboarding process. required: true schema: type: string - name: Content-Type in: header description: Supports \"application/xml\" and \"application/json\". required: true schema: type: string - name: Authorization in: header description: The OAuth Token prefixed with "Bearer" and space in between. required: true schema: type: string requestBody: description: Request body for WorldLink Dodd Frank content: application/json: schema: $ref: '#/components/schemas/disclosure_request' example: in: clientId: '24884' subEntityId: '0001' destinationCountry: IN destinationState: AK destinationCity: ANCHORAGE bankCode: CITIIN00 bankCodeType: B paymentMethod: W paymentCurrency: INR fundingCurrency: USD paymentCurrencyAmount: 100 nonSTPFlag: 'N' isBeneDeduct: 'Y' citiPointOfOrigination: US beneDeductFeeType: T estimatePercentile: 95 chargeCode: SHA releaseTime: '2026-04-23T16:11:23.000' nostroCountry: AU flagODE: 'N' valueDate: '2026-04-23' flagFutureDated: 'N' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/disclosure_response' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error-Message' example: correlationId: q2te~bd8e9b8f-d8e5-4a48-ad13-5d1ec8bb32e815587 message: >- Mismatch of WorldLink client ID or client ID is not maintained. status: '400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Unauthorized httpCode: '401' moreInformation: >- This server could not verify that you are authorized to access the URL '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Not Found httpCode: '404' moreInformation: No resources match requested URI '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Method Not Allowed httpCode: '405' moreInformation: The method is not allowed for the requested URL '415': description: Unsupported Media Type content: application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Unsupported Media Type httpCode: '415' moreInformation: Unsupported Content-Type '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error-Message' example: message: Unable to process your request status: '500' correlationId: q2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352 x-codegen-request-body-name: body /v2/payment/inquiry: post: tags: - WorldLink v2 summary: WorldLink Payment Status Inquiry description: >- CitiConnect WorldLink Payment Status Inquiry allows users to receive information about payments initiated and intermediate processing statuses in real time until the payment is complete. operationId: PaymentStatusInquiries parameters: - name: client_id in: query description: unique identifier which created during onboarding process required: true schema: type: string - name: Content-Type in: header description: Supports \"application/xml\" and \"application/json\". required: true schema: type: string - name: Authorization in: header description: The OAuth Token prefixed with "Bearer" and space in between. required: true schema: type: string requestBody: description: Request Body content: application/xml: schema: $ref: '#/components/schemas/PaymentInquiryRequest' example: >- WL2020010701583700001 application/json: schema: $ref: '#/components/schemas/PaymentInquiryRequest' example: EndToEndId: WL2020010701 WLClientID: '583700001' required: true responses: '200': description: OK content: application/xml: schema: $ref: '#/components/schemas/paymentStatusInquiryResponse' example: >- 2132769616722026-01-13T06:44:05ZBNP SECURITIES SERVICES PRIVATE LIMITED24884Not AvailableNot AvailableNot Applicable20JULMPY_0645A20JULMPY_0645AACCP0.02CitiBank2021-07-27T00:00:00ZKL6KFI2UTDVM99.981002021-07-272021-07-27MPAYPAYMENT 1 PAYMENT 2 PAYMENT 30OFXR1.18830RMETB0FXDT2021-07-23 00:00:00.00FAWF118.830OFXNI020400BTB1/ACC/STEP20FAMT118.830FCCYUSD0WLID24884000111738569CITIFIHXXXXRoger Federer20JULMPY_0645AFI4571308501080486 application/json: schema: $ref: '#/components/schemas/paymentStatusInquiryResponse' examples: Payment-Status-Inquiry-Response-Json: $ref: '#/components/examples/Payment-Status-Inquiry-Response-Json' '400': description: Bad Request content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 400Mismatch of WorldLink Client ID or Client ID not maintainedq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312198 application/json: schema: $ref: '#/components/schemas/Error-Message' example: correlationId: q2te~bd8e9b8f-d8e5-4a48-ad13-5d1ec8bb32e815587 message: >- Mismatch of WorldLink client ID or client ID is not maintained. status: '400' '401': description: Unauthorized content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 401Invalid OAuth TokenPlease use valid OAuth Token application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Unauthorized httpCode: '401' moreInformation: >- This server could not verify that you are authorized to access the URL '404': description: Not found content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 404Not FoundNo resources match requested URI application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Not Found httpCode: '404' moreInformation: No resources match requested URI '405': description: Method Not Allowed content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 405Method Not AllowedThe method is not allowed for the requested URL application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Method Not Allowed httpCode: '405' moreInformation: The method is not allowed for the requested URL '415': description: Unsupported Media Type content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 415Unsupported Media TypeUnsupported Content-Type application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Unsupported Media Type httpCode: '415' moreInformation: Unsupported Content-Type '500': description: Internal Server Error content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 500Unable to process your requestq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352 application/json: schema: $ref: '#/components/schemas/Error-Message' example: message: Unable to process your request status: '500' correlationId: q2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352 x-codegen-request-body-name: payment_status_inquiries /v2/payment/validation: post: tags: - WorldLink v2 summary: WorldLink Payment Upfront Validation description: >- CitiConnect WorldLink Payment Upfront Validation allows you to know upfront, the payment rules required to make payments within a certain country or currency to avoid transaction rejection post submission. This feature will provide the list of fields for a country for which you want the payment rules to be applied. For example, you can send a request for AU ACH and this API will respond with the rules for AU ACH. This API is built on PIUID 949 rules which includes fields required for each country and for each supported payment method. **Content Type:** Supports application/xml or application/json. **Authorization:** The OAuth Token prefixed with Bearer and space in between. **Request:** Specify all mandatory values in the ISOXML V3 (pain.001.001.03) file at a minimum. operationId: PaymentValidation parameters: - name: client_id in: query description: unique identifier which created during onboarding process required: true schema: type: string - name: Content-Type in: header description: Supports \"application/xml\" and \"application/json\". required: true schema: type: string - name: Authorization in: header description: The OAuth Token prefixed with "Bearer" and space in between. required: true schema: type: string requestBody: description: >- Contains the required fields of the ISOXML request body. The request body must be Base64 encoded and enclosed within the \\ tags. content: application/xml: schema: $ref: '#/components/schemas/ValidationRequest' example: >- Wire_SZD_API_14012020-02-20T09:30:471200MSA ILE DE FRANCEADDRDept001Subdept001street name011132323701234567777777townname1townname1townnasubdivctry01GB248840001TRClient5Wire_SZD_FD_API_1401TRF2020-07-22MSA ILE DE FRANCEADDRDept001street name011132323701234567777777townname1subdivctry01SZ789652CADCITICA5AXXX248840001SN41741MSN41741MURGPOTHR200SHARSOGEADPPXXXBene Bank NameWellsprings RenaissancBuilding No 0271492NewtownshipsADRehanHOMEMumbai113232123456ADAD120001203020035910010012796190145799300 application/json: schema: $ref: '#/components/schemas/ValidationRequest' examples: Payment-Validation-Request-Json: $ref: '#/components/examples/Payment-Validation-Request-Json' required: true responses: '200': description: 200 OK content: application/xml: schema: $ref: '#/components/schemas/Document' example: >- Wire_SZD_API_14012020-02-20T09:30:47MSA ILE DE FRANCEADDRDept001Subdept001street name011132323701234567777777townname1townname1townnasubdivctry01GB248840001TRClient5Wire_SZD_API_1401Pain.001.001.032020-02-20T09:30:471200Wire_SZD_FD_API_1401SN41741MSN41741MACCP2002020-07-22URGPOTHRTRF12796190145799300MSA ILE DE FRANCEADDRDept001street name011132323701234567777777townname1subdivctry01SZ789652CADCITICA5AXXX248840001SOGEADPPXXXBene Bank NameWellsprings RenaissancBuilding No 0271492NewtownshipsADRehanHOMEMumbai113232123456ADAD1200012030200359100100 application/json: schema: $ref: '#/components/schemas/Document' examples: Payment-Validation-Response-Json: $ref: '#/components/examples/Payment-Validation-Response-Json' '400': description: Bad Request content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 400Mismatch of WorldLink Client ID or Client ID not maintainedq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312198 application/json: schema: $ref: '#/components/schemas/Error-Message' example: correlationId: q2te~bd8e9b8f-d8e5-4a48-ad13-5d1ec8bb32e815587 message: >- Mismatch of WorldLink client ID or client ID is not maintained. status: '400' '401': description: Unauthorized content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 401Invalid OAuth TokenPlease use valid OAuth Token application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Unauthorized httpCode: '401' moreInformation: >- This server could not verify that you are authorized to access the URL '404': description: Not found content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 404Not FoundNo resources match requested URI application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Not Found httpCode: '404' moreInformation: No resources match requested URI '405': description: Method Not Allowed content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 405Method Not AllowedThe method is not allowed for the requested URL application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Method Not Allowed httpCode: '405' moreInformation: The method is not allowed for the requested URL '415': description: Unsupported Media Type content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 415Unsupported Media TypeUnsupported Content-Type application/json: schema: $ref: '#/components/schemas/Error-Message' example: httpMessage: Unsupported Media Type httpCode: '415' moreInformation: Unsupported Content-Type '500': description: Internal Server Error content: application/xml: schema: $ref: '#/components/schemas/Error-Message' example: >- 500Unable to process your requestq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352 application/json: schema: $ref: '#/components/schemas/Error-Message' example: message: Unable to process your request status: '500' correlationId: q2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352 x-codegen-request-body-name: body components: schemas: Error-Message: type: object properties: correlationId: type: string httpCode: type: string httpMessage: type: string moreInformation: type: string description: Error response body. ValidationRequest: required: - paymentBase64 type: object properties: paymentBase64: type: string description: > paymentBase64: ISO XML V3 (pain.001.001.03) file has to be converted to Base64 format and passed in tags. Based on the use case, you should use one of the ISO schema. Use PACS schema for financial institutions and PAIN format for non-financial clients. ISO schema can be refered from below URL pain.001.001.03 - https://www.iso20022.org/message/14316/download or #/definitions/Pain001 example: >- PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxEb2N1bWVudCB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0idXJuOmlzbzpzdGQ6aXNvOjIwMDIyOnRlY2g6eHNkOnBhaW4uMDAxLjAwMS4wMyI+DQogIDxDc3RtckNkdFRyZkluaXRuPg0KICAgIDxHcnBIZHI+DQogICAgICA8TXNnSWQ+R0JQMTYxMTE0Njk0ODY5PC9Nc2dJZD4NCiAgICAgIDxDcmVEdFRtPjIwMTctMDYtMDJUMTA6MTc6NTU8L0NyZUR0VG0+DQogICAgICA8TmJPZlR4cz4xPC9OYk9mVHhzPg0KICAgICAgPEN0cmxTdW0+MS4wMDwvQ3RybFN1bT4NCiAgICAgIDxJbml0Z1B0eT4NCiAgICAgICAgPE5tPkh1ZHNvbiBBZHZpc29ycyBFdXJvcGUgTHRkPC9ObT4NCiAgICAgIDwvSW5pdGdQdHk+DQogICAgPC9HcnBIZHI+DQogICAgPFBtdEluZj4NCiAgICAgIDxQbXRJbmZJZD4xNDAxNzQ5OCBGdW5kIFRyYW5zZmVyIERvbWVzdGljPC9QbXRJbmZJZD4NCiAgICAgIDxQbXRNdGQ+VFJGPC9QbXRNdGQ+DQogICAgICA8TmJPZlR4cz4xPC9OYk9mVHhzPg0KICAgICAgPEN0cmxTdW0+MS4wMDwvQ3RybFN1bT4NCiAgICAgIDxQbXRUcEluZj4NCiAgICAgICAgPFN2Y0x2bD4NCiAgICAgICAgICA8Q2Q+VVJHUDwvQ2Q+DQogICAgICAgIDwvU3ZjTHZsPg0KICAgICAgPC9QbXRUcEluZj4NCiAgICAgIDxSZXFkRXhjdG5EdD4yMDE5LTA4LTIwPC9SZXFkRXhjdG5EdD4NCiAgICAgIDxEYnRyPg0KICAgICAgICA8Tm0+Q0lUSUJBTksgRS1CVVNJTkVTUyBFVVIgRFVNIERFTU88L05tPg0KICAgICAgICA8UHN0bEFkcj4NCiAgICAgICAgICA8Q3RyeT5HQjwvQ3RyeT4NCiAgICAgICAgPC9Qc3RsQWRyPg0KICAgICAgICA8SWQ+DQogICAgICAgICAgPE9yZ0lkPg0KICAgICAgICAgICAgPEJJQ09yQkVJPkNJVElHQjJMPC9CSUNPckJFST4NCiAgICAgICAgICA8L09yZ0lkPg0KICAgICAgICA8L0lkPg0KICAgICAgPC9EYnRyPg0KICAgICAgPERidHJBY2N0Pg0KICAgICAgICA8SWQ+DQogICAgICAgICAgPE90aHI+DQogICAgICAgICAgICA8SWQ+MTAwMTIyNjI8L0lkPg0KICAgICAgICAgIDwvT3Rocj4NCiAgICAgICAgPC9JZD4NCiAgICAgICAgPENjeT5VU0Q8L0NjeT4NCiAgICAgIDwvRGJ0ckFjY3Q+DQogICAgICA8RGJ0ckFndD4NCiAgICAgICAgPEZpbkluc3RuSWQ+DQogICAgICAgICAgPEJJQz5DSVRJR0IyTDwvQklDPg0KICAgICAgICAgIDxQc3RsQWRyPg0KICAgICAgICAgICAgPEN0cnk+R0I8L0N0cnk+DQogICAgICAgICAgPC9Qc3RsQWRyPg0KICAgICAgICA8L0Zpbkluc3RuSWQ+DQogICAgICA8L0RidHJBZ3Q+DQogICAgICA8Q2hyZ0JyPkRFQlQ8L0NocmdCcj4NCiAgICAgIDxDZHRUcmZUeEluZj4NCiAgICAgICAgPFBtdElkPg0KICAgICAgICAgIDxFbmRUb0VuZElkPlBBMjAxODIwMTkxMjwvRW5kVG9FbmRJZD4NCiAgICAgICAgPC9QbXRJZD4NCiAgICAgICAgPEFtdD4NCiAgICAgICAgICA8SW5zdGRBbXQgQ2N5PSJVU0QiPjEuMDA8L0luc3RkQW10Pg0KICAgICAgICA8L0FtdD4NCiAgICAgICAgPFVsdG10RGJ0cj4NCiAgICAgICAgICA8SWQ+DQogICAgICAgICAgICA8UHJ2dElkPg0KICAgICAgICAgICAgICA8T3Rocj4NCiAgICAgICAgICAgICAgICA8SWQ+UEFSVElDSVBBTlQgSUQgUE9CTyBVSyBCUjYwMCAwMTIzNDU8L0lkPg0KICAgICAgICAgICAgICAgIDxTY2htZU5tPg0KICAgICAgICAgICAgICAgICAgPFBydHJ5PklOU1Q8L1BydHJ5Pg0KICAgICAgICAgICAgICAgIDwvU2NobWVObT4NCiAgICAgICAgICAgICAgPC9PdGhyPg0KICAgICAgICAgICAgPC9QcnZ0SWQ+DQogICAgICAgICAgPC9JZD4NCiAgICAgICAgPC9VbHRtdERidHI+DQogICAgICAgIDxDZHRyQWd0Pg0KICAgICAgICAgIDxGaW5JbnN0bklkPg0KICAgICAgICAgICAgPEJJQz5DSVRJR0IyTDwvQklDPg0KICAgICAgICAgICAgPENsclN5c01tYklkPg0KICAgICAgICAgICAgICA8TW1iSWQ+MTg1MDA4PC9NbWJJZD4NCiAgICAgICAgICAgIDwvQ2xyU3lzTW1iSWQ+DQogICAgICAgICAgICA8Tm0+Q0lUSUJBTksoSVNPKTwvTm0+DQogICAgICAgICAgICA8UHN0bEFkcj4NCiAgICAgICAgICAgICAgPEN0cnk+R0I8L0N0cnk+DQogICAgICAgICAgICA8L1BzdGxBZHI+DQogICAgICAgICAgPC9GaW5JbnN0bklkPg0KICAgICAgICA8L0NkdHJBZ3Q+DQogICAgICAgIDxDZHRyPg0KICAgICAgICAgIDxObT44MDEwNjQzMTIyWCBYWFhYWFhYWFhYWFhYIFhYWDwvTm0+DQogICAgICAgICAgPFBzdGxBZHI+DQogICAgICAgICAgICA8Q3RyeT5HQjwvQ3RyeT4NCiAgICAgICAgICA8L1BzdGxBZHI+DQogICAgICAgICAgPEN0Y3REdGxzPg0KICAgICAgICAgICAgPE5tPldEVyAzIElOVkVTVE1FTlRTIExJTUlURUQ8L05tPg0KICAgICAgICAgIDwvQ3RjdER0bHM+DQogICAgICAgIDwvQ2R0cj4NCiAgICAgICAgPENkdHJBY2N0Pg0KICAgICAgICAgIDxJZD4NCiAgICAgICAgICA8T3Rocj4NCiAgICAgICAgICAgICAgICAgICA8SWQ+MTAwMTIyNjI8L0lkPg0KICAgICAgICAgICAgICAgICAgPC9PdGhyPg0KICAgICAgICAgIDwvSWQ+DQogICAgICAgIDwvQ2R0ckFjY3Q+DQogICAgICAgIDxSbXRJbmY+DQogICAgICAgICAgPFVzdHJkPlRSMDAyNjM4PC9Vc3RyZD4NCiAgICAgICAgPC9SbXRJbmY+DQogICAgICA8L0NkdFRyZlR4SW5mPg0KICAgIDwvUG10SW5mPg0KICA8L0NzdG1yQ2R0VHJmSW5pdG4+DQo8L0RvY3VtZW50Pg== description: >- Object representing payment initiation request. ISO schema can be found at https://www.iso20022.org/catalogue-messages/iso-20022-messages-archive?page=4 and select Payments Initiation V03 and Payments Clearing and Settlement V09 then select more and download mdr file for detailed information on schema and xsd schema definitions. xml: name: Request Document: type: object properties: CstmrPmtStsRpt: $ref: '#/components/schemas/CustomerPaymentStatusReportV03' OriginalPaymentInstruction33: required: - OrgnlPmtInfId type: object properties: RvslPmtInfId: type: string description: >- Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the reversed payment information group. Usage: The instructing party is the party sending the reversal message and not the party that sent the original. OrgnlPmtInfId: maxLength: 35 minLength: 1 type: string description: >- Unique identification, as assigned by the original sending party, to unambiguously identify the original payment information group. OrgnlNbOfTxs: pattern: '[0-9]{1,15}' type: string description: >- Number of individual transactions contained in the original payment information group. OrgnlCtrlSum: maxLength: 18 minLength: 1 type: string description: >- Total of all individual amounts included in the original payment information group, irrespective of currencies.Number of objects represented as a decimal number, for example 0.75 or 45.6. Upto 17 fractional digit allowed. BtchBookg: type: boolean description: >- Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested.Batch booking is used to request and not order a possible batch booking. PmtInfRvsl: type: boolean description: >- Indicates whether or not the reversal applies to the complete original payment information group or to individual transactions within that group.A flag indicating a True or False value. RvslRsnInf: type: array description: >- Provides further details on the reason of the reversal of the transaction. items: $ref: '#/components/schemas/PaymentReversalReason9' TxInf: type: array description: >- Provides information on the original transactions to which the reversal message refers. items: $ref: '#/components/schemas/PaymentTransaction108' PaymentTransaction108: required: - OrgnlEndToEndId - RvsdInstdAmt type: object properties: RvslId: maxLength: 35 minLength: 1 type: string description: >- Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the reversed transaction. OrgnlInstrId: maxLength: 35 minLength: 1 type: string description: >- Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. OrgnlEndToEndId: maxLength: 35 minLength: 1 type: string description: >- Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction. OrgnlUETR: pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' type: string description: >- Universally unique identifier to provide the original end-to-end reference of a payment transaction.Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 Universally Unique IDentifier (UUID) URN Namespace OrgnlInstdAmt: type: object description: >- Amount of money, as provided in the original transaction, to be moved between the debtor and the creditor, before deduction of charges, expressed in the currency, as ordered by the original initiating party.This amount has to be transported unchanged through the transaction chain.Upto 5 fractional digits allowed. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' RvsdInstdAmt: type: object description: >- Amount of money to be moved between the debtor and the creditor, before deduction of charges, in the reversed transaction. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' ChrgBr: type: object description: >- The ChargeBearer applies to the reversal message, not to the original instruction.Specifies if the creditor and/or debtor will bear the charges associated with the processing of the payment transaction. allOf: - $ref: '#/components/schemas/ChargeBearerType1Code' RvslRsnInf: type: array description: >- Provides detailed information on the reversal reason.Provides further details on the reason of the reversal of the transaction. items: $ref: '#/components/schemas/PaymentReversalReason9' OrgnlTxRef: type: object description: >- Set of Key elements used to identify the original transaction that is being referred to. allOf: - $ref: '#/components/schemas/OriginalTransactionReference28' SplmtryData: type: array description: >- Additional information that cannot be captured in the structured elements and/or any other specific block. items: $ref: '#/components/schemas/SupplementaryData1' SupplementaryData1: required: - Envlp type: object properties: PlcAndNm: maxLength: 350 minLength: 1 type: string description: >- Unambiguous reference to the location where the supplementary data must be inserted in the message instance. Envlp: type: object description: >- Technical element wrapping the supplementary data.Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information. Elements from any namespace is allowed and the proces Contents is lax so if the schema cannot be obtained, no errors will occur. xml: namespace: http://com.citi.citiconnect/services/types/citiconnect/v1 OriginalTransactionReference28: required: - DbtrAcct - ReqdExctnDt type: object properties: IntrBkSttlmAmt: type: object description: >- Amount of money moved between the instructing agent and the instructed agent. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Amt: type: object allOf: - $ref: '#/components/schemas/AmountType4Choice' IntrBkSttlmDt: type: string description: >- Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. format: date ReqdColltnDt: type: string description: >- Date and time at which the creditor requests that the amount of money is to be collected from the debtor. format: date ReqdExctnDt: type: object description: >- Date at which the initiating party requests the clearing agent to process the payment. allOf: - $ref: '#/components/schemas/DateAndDateTime2Choice' CdtrSchmeId: type: object description: Credit party that signs the mandate. allOf: - $ref: '#/components/schemas/PartyIdentification135' SttlmInf: $ref: '#/components/schemas/SettlementInstruction7' PmtTpInf: $ref: '#/components/schemas/PaymentTypeInformation27' PmtMtd: $ref: '#/components/schemas/PaymentMethod4Code' MndtRltdInf: $ref: '#/components/schemas/MandateRelatedInformation14' RmtInf: $ref: '#/components/schemas/RemittanceInformation16' UltmtDbtr: type: object description: >- Ultimate party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/Party40Choice' Dbtr: type: object description: Party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/Party40Choice' DbtrAcct: type: object description: >- Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. allOf: - $ref: '#/components/schemas/CashAccount38' DbtrAgt: type: object description: Financial institution servicing an account for the debtor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 DbtrAgtAcct: type: object description: >- Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount38' CdtrAgt: type: object description: Financial institution servicing an account for the creditor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 CdtrAgtAcct: type: object description: >- Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount38' Cdtr: type: object description: Party to which an amount of money is due. allOf: - $ref: '#/components/schemas/Party40Choice' CdtrAcct: type: object description: >- Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount38' UltmtCdtr: type: object description: Ultimate party to which an amount of money is due. allOf: - $ref: '#/components/schemas/Party40Choice' Purp: type: object description: Underlying reason for the payment transaction. allOf: - $ref: '#/components/schemas/Purpose2Choice' description: >- Set of key elements used to identify the original transaction that is being referred to. Purpose2Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external purpose code 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. Prtry: maxLength: 35 minLength: 1 type: string description: Propreitary Details description: >- Purpose is used by the end customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain. Either Code Or Proprietary is required. Party40Choice: required: - Pty type: object properties: Pty: type: object description: Specifies the identification of a person or an organisation. allOf: - $ref: '#/components/schemas/PartyIdentification135' Agt: type: object description: >- Unique and unambiguous identification of a financial institution or a branch of a financial institution. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 description: Specifies the identification of a party or an agent. RemittanceInformation16: type: object properties: Strd: type: array description: >- Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. items: $ref: '#/components/schemas/StructuredRemittanceInformation16' Ustrd: type: array description: >- Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. items: $ref: '#/components/schemas/Max140Text' StructuredRemittanceInformation16: type: object properties: RfrdDocInf: type: array description: >- Set of elements used to identify the documents referred to in the remittance information. items: $ref: '#/components/schemas/ReferredDocumentInformation7' RfrdDocAmt: $ref: '#/components/schemas/RemittanceAmount3' CdtrRefInf: $ref: '#/components/schemas/CreditorReferenceInformation2' Invcr: type: object description: >- Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor. allOf: - $ref: '#/components/schemas/PartyIdentification135' Invcee: type: object description: >- Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor. allOf: - $ref: '#/components/schemas/PartyIdentification135' TaxRmt: type: object description: >- Provides remittance information about a payment made for tax-related purposes. allOf: - $ref: '#/components/schemas/TaxInformation7' GrnshmtRmt: type: object description: >- Provides remittance information about a payment for garnishment-related purposes. allOf: - $ref: '#/components/schemas/Garnishment3' AddtlRmtInf: maxItems: 3 type: array description: >- Additional information, in free text form, to complement the structured remittance information. items: $ref: '#/components/schemas/Max140Text' Garnishment3: required: - Tp type: object properties: Tp: type: object description: Specifies the type of garnishment. allOf: - $ref: '#/components/schemas/GarnishmentType1' Grnshee: type: object description: >- Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher. allOf: - $ref: '#/components/schemas/PartyIdentification135' GrnshmtAdmstr: type: object description: >- Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary. allOf: - $ref: '#/components/schemas/PartyIdentification135' RefNb: maxLength: 140 minLength: 1 type: string description: >- Reference information that is specific to the agency receiving the garnishment. Dt: type: string description: Date of payment which garnishment was taken from. format: date RmtdAmt: type: object description: Amount of money remitted for the referred document. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' FmlyMdclInsrncInd: type: boolean description: >- Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available.A flag indicating a True or False value. MplyeeTermntnInd: type: boolean description: >- Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated.A flag indicating a True or False value. description: >- Provides remittance information about a payment for garnishment-related purposes. GarnishmentType1: required: - CdOrPrtry type: object properties: CdOrPrtry: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the garnishment type as published in an external document type code list. Prtry: maxLength: 35 minLength: 1 type: string description: Proprietary Details description: >- Provides the type details of the garnishment.Either Code or Prtry is required Issr: maxLength: 35 minLength: 1 type: string description: Identification of the issuer of the garnishment type. TaxParty1: type: object properties: RegnId: type: object description: >- Unique identification, as assigned by an organisation, to unambiguously identify a party. allOf: - $ref: '#/components/schemas/Max35Text' TaxId: type: object description: Tax identification number of the creditor. allOf: - $ref: '#/components/schemas/Max35Text' TaxTp: type: object description: Type of tax payer. allOf: - $ref: '#/components/schemas/Max35Text' description: Party on the credit side of the transaction to which the tax applies TaxAuthorisation1: type: object properties: Nm: type: object description: Name of the debtor or the debtor's authorised representative. allOf: - $ref: '#/components/schemas/Max140Text' Titl: type: object description: >- Title or position of debtor or the debtor's authorised representative. allOf: - $ref: '#/components/schemas/Max35Text' description: Details of the authorised tax paying party. TaxParty2: type: object properties: Authstn: type: object allOf: - $ref: '#/components/schemas/TaxAuthorisation1' RegnId: type: object description: >- Unique identification, as assigned by an organisation, to unambiguously identify a party. allOf: - $ref: '#/components/schemas/Max35Text' TaxId: type: object description: Tax identification number of the debtor. allOf: - $ref: '#/components/schemas/Max35Text' TaxTp: type: object description: Type of tax payer. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Set of elements used to identify the party on the debit side of the transaction to which the tax applies. TaxInformation7: type: object properties: Cdtr: type: object allOf: - $ref: '#/components/schemas/TaxParty1' Dbtr: type: object allOf: - $ref: '#/components/schemas/TaxParty2' AdmstnZone: type: object description: Territorial part of a country to which the tax payment is related. allOf: - $ref: '#/components/schemas/Max35Text' RefNb: type: object description: Tax reference information that is specific to a taxing agency. allOf: - $ref: '#/components/schemas/Max140Text' Mtd: type: object description: >- Method used to indicate the underlying business or how the tax is paid. allOf: - $ref: '#/components/schemas/Max35Text' TtlTaxblBaseAmt: type: object description: Total amount of money on which the tax is based. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TtlTaxAmt: type: object description: Total amount of money as result of the calculation of the tax. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Dt: type: object description: Date by which tax is due. allOf: - $ref: '#/components/schemas/ISODate' SeqNb: maxLength: 18 type: string description: Sequential number of the tax report. Rcrd: type: array description: Record of tax details. items: $ref: '#/components/schemas/TaxRecord2' description: >- Provides remittance information about a payment made for tax-related purposes. TaxRecord2: type: object properties: Tp: type: object description: High level code to identify the type of tax details. allOf: - $ref: '#/components/schemas/Max35Text' Ctgy: type: object description: Specifies the tax code as published by the tax authority. allOf: - $ref: '#/components/schemas/Max35Text' CtgyDtls: type: object description: Provides further details of the category tax code. allOf: - $ref: '#/components/schemas/Max35Text' DbtrSts: type: object description: >- Code provided by local authority to identify the status of the party that has drawn up the settlement document. allOf: - $ref: '#/components/schemas/Max35Text' CertId: type: object description: >- Identification number of the tax report as assigned by the taxing authority. allOf: - $ref: '#/components/schemas/Max35Text' FrmsCd: type: object description: >- Identifies, in a coded form, on which template the tax report is to be provided. allOf: - $ref: '#/components/schemas/Max35Text' Prd: type: object allOf: - $ref: '#/components/schemas/TaxPeriod2' TaxAmt: type: object allOf: - $ref: '#/components/schemas/TaxAmount2' AddtlInf: type: object description: Further details of the tax record. allOf: - $ref: '#/components/schemas/Max140Text' TaxRecordDetails2: required: - Amt type: object properties: Amt: type: object description: Underlying tax amount related to the specified period. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Prd: type: object allOf: - $ref: '#/components/schemas/TaxPeriod2' TaxAmount2: type: object properties: Dtls: type: array description: >- Set of elements used to provide details on the tax period and amount. items: $ref: '#/components/schemas/TaxRecordDetails2' Rate: maxLength: 11 type: string description: Rate used to calculate the tax.Upto 10 fractional digits. TaxblBaseAmt: type: object description: Amount of money on which the tax is based. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TtlAmt: type: object description: >- Total amount that is the result of the calculation of the tax for the record. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: >- Set of elements used to provide information on the amount of the tax record. TaxPeriod2: type: object properties: FrToDt: type: object description: >- Range of time between a start date and an end date for which the tax report is provided. allOf: - $ref: '#/components/schemas/DatePeriod2' Tp: type: object allOf: - $ref: '#/components/schemas/TaxRecordPeriod1Code' Yr: type: object description: Year related to the tax payment. allOf: - $ref: '#/components/schemas/ISODate' description: >- Set of elements used to provide details on the period of time related to the tax payment. DatePeriod2: required: - FrDt - ToDt type: object properties: FrDt: type: object description: Start date of the range. allOf: - $ref: '#/components/schemas/ISODate' ToDt: type: object description: End date of the range. allOf: - $ref: '#/components/schemas/ISODate' TaxRecordPeriod1Code: type: string description: >- Identification of the period related to the tax payment.

MM01 : Tax is related to the first month of the period.

MM02 : Tax is related to the second month of the period.

MM03 : Tax is related to the third month of the period.

MM04 : Tax is related to the fourth month of the period.

MM05 : Tax is related to the fifth month of the period.

MM06 : Tax is related to the sixth month of the period.

MM07 : Tax is related to the seventh month of the period.

MM08 : Tax is related to the eighth month of the period.

MM09 : Tax is related to the ninth month of the period.

MM10 : Tax is related to the tenth month of the period.

MM11 : Tax is related to the eleventh month of the period.

MM12 : Tax is related to the twelfth month of the period.

QTR1 : Tax is related to the first quarter of the period.

QTR2 : Tax is related to the second quarter of the period.

QTR3 : Tax is related to the third quarter of the period.

QTR4 : Tax is related to the fourth quarter of the period.

HLF1 : Tax is related to the first half of the period.

HLF2 : Tax is related to the second half of the period. enum: - MM01 - MM02 - MM03 - MM04 - MM05 - MM06 - MM07 - MM08 - MM09 - MM10 - MM11 - MM12 - QTR1 - QTR2 - QTR3 - QTR4 - HLF1 - HLF2 DocumentType3Code: type: string description: >- Type of creditor reference, in a coded form.

RADM : Document is a remittance advice sent separately from the current transaction.

RPIN : Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.

FXDR : Document is a pre-agreed or pre-arranged foreign exchange transaction to which the payment transaction refers.

DISP : Document is a dispatch advice.

PUOR : Document is a purchase order

SCOR : Document is a structured communication reference provided by the creditor to identify the referred transaction. enum: - RADM - RPIN - FXDR - DISP - PUOR - SCOR CreditorReferenceType1Choice: type: object properties: Cd: $ref: '#/components/schemas/DocumentType3Code' Prtry: type: object description: Creditor reference type, in a proprietary form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Coded or proprietary format creditor reference type. Either Code or Proprietary field value should be passed on request. CreditorReferenceType2: required: - CdOrPrtry type: object properties: CdOrPrtry: $ref: '#/components/schemas/CreditorReferenceType1Choice' Issr: type: object description: Entity that assigns the credit reference type. allOf: - $ref: '#/components/schemas/Max35Text' description: Specifies the type of creditor reference. CreditorReferenceInformation2: type: object properties: Ref: type: object description: >- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. allOf: - $ref: '#/components/schemas/Max35Text' Tp: $ref: '#/components/schemas/CreditorReferenceType2' description: >- Reference information provided by the creditor to allow the identification of the underlying documents. ReferredDocumentInformation7: type: object properties: Nb: type: object description: Unique and unambiguous identification of the referred document. allOf: - $ref: '#/components/schemas/Max35Text' RltdDt: type: object description: Date associated with the referred document. allOf: - $ref: '#/components/schemas/ISODate' Tp: $ref: '#/components/schemas/ReferredDocumentType4' LineDtls: type: array description: >- Set of elements used to provide the content of the referred document line. items: $ref: '#/components/schemas/DocumentLineInformation1' DocumentLineInformation1: required: - Id type: object properties: Id: type: array description: Provides identification of the document line. items: $ref: '#/components/schemas/DocumentLineIdentification1' Desc: maxLength: 2048 minLength: 1 type: string description: Description associated with the document line. Amt: type: object allOf: - $ref: '#/components/schemas/RemittanceAmount3' RemittanceAmount3: type: object properties: DuePyblAmt: type: object description: >- Amount specified is the exact amount due and payable to the creditor. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' DscntApldAmt: type: array description: >- Amount of money that results from the application of an agreed discount to the amount due and payable to the creditor. items: $ref: '#/components/schemas/DiscountAmountAndType1' CdtNoteAmt: type: object description: >- Amount specified for the referred document is the amount of a credit note. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TaxAmt: type: array description: Amount of the tax items: $ref: '#/components/schemas/TaxAmountAndType1' AdjstmntAmtAndRsn: type: array description: >- Set of elements used to provide information on the amount and reason of the document adjustment. items: $ref: '#/components/schemas/DocumentAdjustment1' RmtdAmt: type: object description: Amount of money remitted for the referred document. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: >- Set of elements used to provide details on the amounts of the referred document. DocumentAdjustment1: required: - Amt type: object properties: AddtlInf: type: object description: Provides further details on the document adjustment. allOf: - $ref: '#/components/schemas/Max140Text' Amt: type: object description: Amount of money of the document adjustment. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' CdtDbtInd: $ref: '#/components/schemas/CreditDebitCode' Rsn: type: object description: Specifies the reason for the adjustment. allOf: - $ref: '#/components/schemas/Max4Text' Max4Text: maxLength: 4 minLength: 1 type: string CreditDebitCode: type: string description: >- Specifies whether the adjustment must be subtracted or added to the total amount.

CRDT : Operation is an increase.

DBIT : Operation is a decrease. enum: - CRDT - DBIT TaxAmountAndType1: type: object properties: Tp: type: object allOf: - $ref: '#/components/schemas/TaxAmountType1Choice' Amt: type: object allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: Amount of the tax. TaxAmountType1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the nature, or use, of the amount 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. Prtry: maxLength: 35 minLength: 1 type: string description: Propreitary Details description: Specifies the type of the amount.Either Propreitary or Code is required DiscountAmountAndType1: type: object properties: Tp: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the nature, or use, of the amount 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. Prtry: maxLength: 4 minLength: 1 type: string description: Proprietary Details description: >- Specifies the type of the amount. Either Code or Proprietary is required Amt: type: object allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' DocumentLineIdentification1: type: object properties: Tp: type: object allOf: - $ref: '#/components/schemas/DocumentLineType1' Nb: maxLength: 35 minLength: 1 type: string description: Identification of the type specified for the referred document line. RltdDt: type: string description: Date associated with the referred document line. format: date DocumentLineType1: required: - CdOrPrtry type: object properties: CdOrPrtry: type: object description: >- Provides the type details of the referred document line identification. Either Code Or Proprietary is required allOf: - $ref: '#/components/schemas/DocumentLineType1Choice' Issr: maxLength: 35 minLength: 1 type: string description: >- Identification of the issuer of the reference document line identificationtype. DocumentLineType1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the document line type as published in an external document type code list. Prtry: maxLength: 35 minLength: 1 type: string description: Propreitary Description description: Either Code or Proprietary is required ReferredDocumentType4: required: - CdOrPrtry type: object properties: CdOrPrtry: $ref: '#/components/schemas/ReferredDocumentType3Choice' Issr: type: object description: Identification of the issuer of the reference document type. allOf: - $ref: '#/components/schemas/Max35Text' description: Specifies the type of referred document. ReferredDocumentType3Choice: type: object properties: Cd: $ref: '#/components/schemas/DocumentType6Code' Prtry: type: object description: Proprietary identification of the type of the remittance document. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Provides the type details of the referred document. Either Code or Proprietary field value should be passed on request. DocumentType6Code: type: string description: >- Document type in a coded form. Specifies a type of financial or commercial document.

MSIN : Document is an invoice claiming payment for the supply of metered services, for example gas or electricity supplied to a fixed meter.

CNFA : Document is a credit note for the final amount settled for a commercial transaction.

DNFA : Document is a debit note for the final amount settled for a commercial transaction.

CINV : Document is an invoice.

CREN : Document is a credit note.

DEBN : Document is a debit note.

HIRI : Document is an invoice for the hiring of human resources or renting goods or equipment.

SBIN : Document is an invoice issued by the debtor.

SVGS : Account used for savings.

CMCN : Document is an agreement between the parties, stipulating the terms and conditions of the delivery of goods or services.

SOAC : Document is a statement of the transactions posted to the debtor's account at the supplier.

DISP : Document is a dispatch advice.

BOLD : Document is a shipping notice.

VCHR : Document is an electronic payment document.

AROI : Document is a payment that applies to a specific source document.

TSUT : Document is a transaction identifier as assigned by the Trade Services Utility

TSUT : Document is a purchase order. enum: - MSIN - CNFA - DNFA - CINV - CREN - DEBN - HIRI - SBIN - CMCN - SOAC - DISP - BOLD - VCHR - AROI - TSUT - PUOR MandateRelatedInformation14: required: - ElctrncSgntr type: object properties: MndtId: type: object description: >- Unique identification, as assigned by the creditor, to unambiguously identify the mandate. allOf: - $ref: '#/components/schemas/Max35Text' DtOfSgntr: type: string description: >- Date on which the direct debit mandate has been signed by the debtor. format: date AmdmntInd: type: boolean description: >- Indicator notifying whether the underlying mandate is amended or not. AmdmntInfDtls: type: object allOf: - $ref: '#/components/schemas/AmendmentInformationDetails13' ElctrncSgntr: maxLength: 1025 minLength: 1 type: string description: >- Additional security provisions, such as a digital signature, as provided by the debtor. FrstColltnDt: type: string description: Date of the first collection of a direct debit as per the mandate. format: date FnlColltnDt: type: string description: Date of the final collection of a direct debit as per the mandate. format: date Frqcy: type: object allOf: - $ref: '#/components/schemas/Frequency36Choice' Rsn: type: object allOf: - $ref: '#/components/schemas/MandateSetupReason1Choice' TrckgDays: pattern: '[0-9]{2}' type: string description: >- Specifies the number of days the direct debit instruction must be tracked. description: >- Provides further details of the mandate signed between the creditor and the debtor.If AmendmentIndicator is true, then AmendementInformationDetails must be present.If AmendmentIndicator is false, then AmendmentInformationDetails is not allowed. AmendmentInformationDetails13: type: object properties: OrgnlMndtId: type: object description: >- Unique identification, as assigned by the creditor, to unambiguously identify the original mandate. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlCdtrSchmeId: type: object description: Original creditor scheme identification that has been modified. allOf: - $ref: '#/components/schemas/PartyIdentification135' OrgnlCdtrAgt: type: object description: Original creditor agent that has been modified. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 OrgnlCdtrAgtAcct: type: object description: Original creditor agent acount that has been modified. allOf: - $ref: '#/components/schemas/CashAccount38' OrgnlDbtr: type: object description: Original debtor that has been modified. allOf: - $ref: '#/components/schemas/PartyIdentification135' OrgnlDbtrAcct: type: object description: Original debtor account that has been modified. allOf: - $ref: '#/components/schemas/CashAccount38' OrgnlDbtrAgt: type: object description: Original debtor agent that has been modified. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 OrgnlDbtrAgtAcct: type: object description: Original debtor agent account that has been modified. allOf: - $ref: '#/components/schemas/CashAccount38' OrgnlFnlColltnDt: type: string description: Original final collection date that has been modified. format: date OrgnlFrqcy: type: object allOf: - $ref: '#/components/schemas/Frequency36Choice' OrgnlRsn: type: object allOf: - $ref: '#/components/schemas/MandateSetupReason1Choice' OrgnlTrckgDays: pattern: '[0-9]{2}' type: string description: Original number of tracking days that has been modified. description: List of mandate elements that have been modified. MandateSetupReason1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external mandate setup reason code in the format of character string with a maximum length of 4 characters. Prtry: maxLength: 70 minLength: 1 type: string description: Proprietary Details description: Either of Code or Proprietary is required. Frequency36Choice: required: - Prd - PtInTm - Tp type: object properties: Tp: type: object allOf: - $ref: '#/components/schemas/Frequency6Code' Prd: required: - CntPerPrd - Tp type: object properties: Tp: type: object description: >- Period for which the number of instructions are to be created and processed. allOf: - $ref: '#/components/schemas/Frequency6Code' CntPerPrd: maxLength: 18 type: string description: >- Number of instructions to be created and processed during the specified period.Number of objects represented as a decimal number, for example 0.75 or 45.6. Fractional Digits Upto 17 allowed description: >- Defines a frequency in terms on counts per period for a specific period type. PtInTm: type: object allOf: - $ref: '#/components/schemas/FrequencyAndMoment1' FrequencyAndMoment1: required: - PtInTm - Tp type: object properties: Tp: type: object allOf: - $ref: '#/components/schemas/Frequency6Code' PtInTm: pattern: '[0-9]{2}' type: string description: >- Further information on the exact point in time the event should take place. description: >- Defines a frequency in terms a specific moment within a specified period type. Frequency6Code: type: string description: >- Specifies the regularity of an event.

YEAR : Event takes place every year or once a year.

MNTH : Event takes place every month or once a month.

QURT : Event takes place every three months or four times a year.

MIAN : Event takes place every six months or two times a year.

WEEK : Event takes place once a week.

DAIL : Event takes place every day.

ADHO : Event takes place on request or as necessary.

INDA : Event takes place several times a day.

FRTN : Event takes place every two weeks. enum: - YEAR - MNTH - QURT - MIAN - WEEK - DAIL - ADHO - INDA - FRTN PaymentMethod4Code: type: string description: >- Specifies the means of payment that will be used to move the amount of money.

CHK : Written order to a bank to pay a certain amount of money from one person to another person.

TRF : Transfer of an amount of money in the books of the account servicer.

DD : Collection of an amount of money from the debtor's bank account by the creditor. The amount of money and dates of collections may vary.

TRA : Transfer of an amount of money in the books of the account servicer. An advice should be sent back to the account owner. enum: - CHK - TRF - DD - TRA PaymentTypeInformation27: type: object properties: InstrPrty: $ref: '#/components/schemas/Priority2Code' ClrChanl: type: string description: >- Specifies the clearing channel to be used to process the payment instruction.

RTGS : Clearing channel is a real-time gross settlement system.

RTNS : Clearing channel is a real-time net settlement system.

MPNS : Clearing channel is a mass payment net settlement system.

BOOK : Payment through internal book transfer. enum: - RTGS - RTNS - MPNS - BOOK SvcLvl: type: array items: $ref: '#/components/schemas/ServiceLevel8Choice' LclInstrm: $ref: '#/components/schemas/LocalInstrument2Choice' SeqTp: type: string description: >- Identifies the direct debit sequence, such as first, recurrent, final or one-off.

FRST : First collection of a series of direct debit instructions.

RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.

FNAL : Final collection of a series of direct debit instructions.

OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction.

RPRE :Collection used to re-present previously reversed or returned direct debit transactions. enum: - FRST - RCUR - FNAL - OOFF - RPRE CtgyPurp: type: object description: >- Specifies the high level purpose of the instruction based on a set of pre-defined categories. allOf: - $ref: '#/components/schemas/CategoryPurpose1Choice' description: Set of elements used to further specify the type of transaction. CategoryPurpose1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Category purpose, as published in an external category purpose code list. Prtry: type: object description: Category purpose, in a proprietary form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Specifies the high level purpose of the instruction based on a set of pre-defined categories. Either Code or Proprietary field value should be passed in request. Priority2Code: type: string description: >- Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

HIGH : Priority level is high.

NORM : Priority level is normal. enum: - HIGH - NORM ServiceLevel8Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external service level code 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. Prtry: type: object description: >- Specifies a pre-agreed service or level of service between the parties, as a proprietary code. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Agreement under which or rules under which the transaction should be processed. Either code or proprietary field values should be sent in request. LocalInstrument2Choice: type: object properties: Cd: type: object description: >- Specifies the external local instrument code in the format of character string with a maximum length of 35 characters.The list of valid codes is an external code list published separately. allOf: - $ref: '#/components/schemas/Max35Text' Prtry: type: object description: Specifies the local instrument, as a proprietary code. allOf: - $ref: '#/components/schemas/Max35Text' description: >- User community specific instrument. Either Code or Proprietary field value should be passed in request. SettlementInstruction7: required: - SttlmMtd type: object properties: SttlmMtd: type: object allOf: - $ref: '#/components/schemas/SettlementMethod1Code' SttlmAcct: type: object description: >- A specific purpose account used to post debit and credit entries as a result of the transaction. allOf: - $ref: '#/components/schemas/CashAccount38' ClrSys: $ref: '#/components/schemas/ClearingSystemIdentification3Choice' InstgRmbrsmntAgt: type: object description: >- Agent through which the instructing agent will reimburse the instructed agent. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 InstgRmbrsmntAgtAcct: type: object description: >- Unambiguous identification of the account of the instructing reimbursement agent account at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount38' InstdRmbrsmntAgt: type: object description: Agent at which the instructed agent will be reimbursed. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 InstdRmbrsmntAgtAcct: type: object description: >- Unambiguous identification of the account of the instructed reimbursement agent account at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount38' ThrdRmbrsmntAgtAcct: type: object description: >- Unambiguous identification of the account of the third reimbursement agent account at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount38' ThrdRmbrsmntAgt: type: object description: Agent at which the instructed agent will be reimbursed. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 description: >- Specifies the details on how the settlement of the original transaction(s) between the instructing agent and the instructed agent was completed. If ThirdReimbursementAgent is present, then InstructingReimbursementAgent and InstructedReimbursementAgent must both be present. If SettlementMethod is equal to INDA or INGA, then ReimbursementAgent(s) and ClearingSystem are not allowed.If SettlementMethod is equal to COVE, then SettlementAccount and ClearingSystem are not allowed.If SettlementMethod is equal to COVE, then InstructedReimbursementAgent or InstructingReimbursementAgent must be present.If SettlementMethod is equal to CLRG, then SettlementAccount and ReimbursementAgent(s) are not allowed.If InstructingReimbursementAgentAccount is present, then InstructingReimbursementAgent must be present.If InstructedReimbursementAgentAccount is present, then InstructedReimbursementAgent must be present.If ThirdReimbursementAgentAccount is present, then ThirdReimbursementAgent must be present. ClearingSystemIdentification3Choice: type: object properties: Cd: maxLength: 3 minLength: 1 type: string description: >- Infrastructure through which the payment instruction is processed, as published in an external clearing system identification code list.Specifies the cash clearing system, as published in an external cash clearing system code list. Prtry: type: object description: Clearing system identification in a proprietary form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. Either Code or Proprietary field value should be passed in request. CashAccount38: required: - Id type: object properties: Ccy: type: object description: Identification of the currency in which the account is held. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' Id: $ref: '#/components/schemas/AccountIdentification4Choice' Nm: type: object 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. allOf: - $ref: '#/components/schemas/Max70Text' Tp: type: object allOf: - $ref: '#/components/schemas/CashAccountType2Choice' Prxy: required: - Id type: object properties: Tp: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external proxy account type code, as published in the proxy account type external code set. Prtry: maxLength: 35 minLength: 1 type: string description: Proprietary details description: >- Type of the proxy identification.Either of Code or Propreitary is required. Id: maxLength: 2048 minLength: 1 type: string description: >- Identification used to indicate the account identification under another specified name. description: >- Specifies an alternate assumed name for the identification of the account. CashAccountType2Choice: type: object properties: Cd: 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. Prtry: type: object description: Nature or use of the account in a proprietary form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Specifies the nature, or use of the account. Either Code or Proprietary field value should be passed on request. AccountIdentification4Choice: type: object properties: IBAN: $ref: '#/components/schemas/IBAN2007Identifier' Othr: $ref: '#/components/schemas/GenericAccountIdentification1' description: >- Unique and unambiguous identification for the account between the account owner and the account servicer. Either iban or Othr field value should be passed on request. GenericAccountIdentification1: required: - Id type: object properties: Id: maxLength: 34 minLength: 1 type: string description: Identification assigned by an institution. Issr: type: object description: Entity that assigns the identification. allOf: - $ref: '#/components/schemas/Max35Text' SchmeNm: type: object description: >- Name of the identification scheme.Either Code or Proprietary is required allOf: - $ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice' description: >- Unique identification of an account, as assigned by the account servicer, using an identification scheme. IBAN2007Identifier: 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. SettlementMethod1Code: type: string description: >- Method used to settle the (batch of) payment instructions.

INDA : Settlement is done by the agent instructed to execute a payment instruction.

INGA : Settlement is done by the agent instructing and forwarding the payment to the next party in the payment chain.

COVE : Settlement is done through a cover payment.

CLRG : Settlement is done through a payment clearing system. enum: - INDA - INGA - COVE - CLRG DateAndDateTime2Choice: type: object properties: Dt: type: string description: >- Date at which the initiating party requests the clearing agent to process the payment. format: date DtTm: type: string description: >- Date and Time at which the initiating party requests the clearing agent to process the payment. format: date-time description: Either Choice between a date or a date and time format. AmountType4Choice: type: object properties: EqvtAmt: $ref: '#/components/schemas/EquivalentAmount2' InstdAmt: type: object description: >- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: >- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Either EqvtAmt or InstdAmt field value should be passed on request. EquivalentAmount2: required: - Amt - CcyOfTrf type: object properties: Amt: type: object description: >- Amount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account, and to be moved in a different currency. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' CcyOfTrf: type: object description: >- Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' description: >- Amount of money to be moved between the debtor and creditor, expressed in the currency of the debtor's account, and the currency in which the amount is to be moved. ChargeBearerType1Code: type: string description: >- Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

DEBT : All transaction charges are to be borne by the debtor.

CRED : All transaction charges are to be borne by the creditor.

SHAR : In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.

SLEV : Charges are to be applied following the rules agreed in the service level and/or scheme. enum: - DEBT - CRED - SHAR - SLEV ActiveOrHistoricCurrencyAndAmount: required: - Ccy type: object properties: Ccy: type: object description: >- Currency code. Passed as the tag attribute.The unit of currency is explicit and compliant with ISO 4217 allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' $: $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType' ActiveOrHistoricCurrencyAndAmount_SimpleType: maxLength: 18 type: string description: >- The number of fractional digits (or minor unit of currency) must comply with ISO 4217. Note: The decimal separator is a dot.A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. The number of fractional digits should be 5. ActiveOrHistoricCurrencyCode: pattern: '[A-Z]{3,3}' type: string OriginalGroupHeader16: required: - OrgnlMsgId - OrgnlMsgNmId type: object properties: OrgnlMsgId: maxLength: 35 minLength: 1 type: string description: >- Point to point reference, as assigned by the original instructing party, to unambiguously identify the original message. OrgnlMsgNmId: maxLength: 35 minLength: 1 type: string description: >- Specifies the original message name identifier to which the message refers. OrgnlCreDtTm: type: string description: Date and time at which the original message was created. format: date-time RvslRsnInf: type: array description: Provides detailed information on the reversal reason. items: $ref: '#/components/schemas/PaymentReversalReason9' PaymentReversalReason9: type: object properties: Orgtr: type: object description: Party that issues the reversal. allOf: - $ref: '#/components/schemas/PartyIdentification135' Rsn: type: object description: >- Specifies the reason for the reversal.Either from Code or Proprietary is required allOf: - $ref: '#/components/schemas/ReversalReason4Choice' AddtlInf: type: array description: Further details on the reversal reason. items: type: string ReversalReason4Choice: required: - Cd type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the reversal reason, as published in an external reversal reason code list. Prtry: maxLength: 35 minLength: 1 type: string description: Specifies about the proprietary description: Either from Code or Proprietary is required GroupHeader88: required: - CreDtTm - MsgId - NbOfTxs type: object properties: MsgId: maxLength: 35 minLength: 1 type: string description: >- Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. CreDtTm: type: string description: >- This field specifies the date when the Refund is initiated. The date format is: YYYY-MM-DDThh:mm:ss.Date and time at which the message was created. format: date-time Authstn: maxItems: 2 minItems: 1 type: array description: >- User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message. items: $ref: '#/components/schemas/Authorisation1Choice' NbOfTxs: pattern: '[0-9]{1,15}' type: string description: >- Number of individual transactions contained in the message. If GroupReversal is true, then NumberOfTransactions equals the number of transactions in the original message. CtrlSum: maxLength: 18 minLength: 1 type: string description: >- Total of all individual amounts included in the message, irrespective of currencies. Upto 17 fractional digits. If GroupReversal is true, then ControlSum is not allowed. GrpRvsl: type: boolean description: >- Indicates whether the reversal applies to the whole group of transactions or to individual transactions within the original group.A flag indicating a True or False value. InitgPty: type: object description: >- Party that initiates the reversal message.This can be either the creditor or a party that initiates the reversal of the direct debit on behalf of the creditor. allOf: - $ref: '#/components/schemas/PartyIdentification135' FwdgAgt: type: object allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 DbtrAgt: type: object description: Financial institution servicing an account for the debtor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 CdtrAgt: type: object description: Financial institution servicing an account for the creditor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification6 BranchAndFinancialInstitutionIdentification6: required: - FinInstnId type: object properties: BrnchId: $ref: '#/components/schemas/BranchData3' FinInstnId: $ref: '#/components/schemas/FinancialInstitutionIdentification18' BranchData3: required: - Id type: object properties: Id: type: object description: >- Unique and unambiguous identification of a branch of a financial institution. allOf: - $ref: '#/components/schemas/Max35Text' LEI: pattern: '[A-Z0-9]{18,18}[0-9]{2,2}' type: string description: >- Legal entity identification for the branch of the financial institution.Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI). Nm: type: object description: >- Name by which an agent is known and which is usually used to identify that agent. allOf: - $ref: '#/components/schemas/Max140Text' PstlAdr: type: object allOf: - $ref: '#/components/schemas/PostalAddress24' description: Identifies a specific branch of a financial institution. FinancialInstitutionIdentification18: required: - Nm 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)". ClrSysMmbId: $ref: '#/components/schemas/ClearingSystemMemberIdentification2' LEI: pattern: '[A-Z0-9]{18,18}[0-9]{2,2}' type: string description: Legal entity identifier of the financial institution. Nm: type: object description: >- Name by which an agent is known and which is usually used to identify that agent. allOf: - $ref: '#/components/schemas/Max140Text' PstlAdr: type: object allOf: - $ref: '#/components/schemas/PostalAddress24' Othr: type: object allOf: - $ref: '#/components/schemas/GenericFinancialIdentification1' description: >- Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. GenericFinancialIdentification1: required: - Id type: object properties: Id: type: object description: Unique and unambiguous identification of a person. allOf: - $ref: '#/components/schemas/Max35Text' Issr: type: object description: Entity that assigns the identification. allOf: - $ref: '#/components/schemas/Max35Text' SchmeNm: $ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice' description: >- Unique identification of an agent, as assigned by an institution, using an identification scheme. FinancialIdentificationSchemeName1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external financial institution identification scheme name code 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. Prtry: type: object description: Name of the identification scheme, in a free text form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Name of the identification scheme. Either Code or Proprietary field value should be passed on request. ClearingSystemMemberIdentification2: required: - MmbId type: object properties: ClrSysId: type: object properties: Cd: maxLength: 5 minLength: 1 type: string description: >- It Specifies the clearing system identification code, as published in an external clearing system identification code list. Prtry: type: object description: >- Identification code for a clearing system, that has not yet been identified in the list of clearing systems. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.Either from Code Or Proprietary is required MmbId: type: object description: Identification of a member of a clearing system. allOf: - $ref: '#/components/schemas/Max35Text' description: Information used to identify a member within a clearing system. Authorisation1Choice: type: object properties: Cd: type: object description: >- Specifies the level of approval depending on a number of factors, including payment type, threshold amount or local country or operations practice.

AUTH : Indicates a file has been pre authorised or approved within the originating customer environment and no further approval is required.

FDET : Indicates that a file requires additional file level approval, with the ability to view both the payment information block and supporting customer credit transaction detail.

FSUM : Indicates that a file requires additional file level approval, with the ability to view only the payment information block level information.

ILEV : Indicates that a file requires all customer transactions to be authorised or approved. allOf: - $ref: '#/components/schemas/Authorisation1Code' Prtry: maxLength: 128 minLength: 1 type: string description: Specifies the proprietary description description: Either of Code or Proprietary is required. Authorisation1Code: type: string description: >-

AUTH : Indicates a file has been pre authorised or approved within the originating customer environment and no further approval is required.

FDET : Indicates that a file requires additional file level approval, with the ability to view both the payment information block and supporting customer credit transaction detail.

FSUM : Indicates that a file requires additional file level approval, with the ability to view only the payment information block level information.

ILEV : Indicates that a file requires all customer transactions to be authorised or approved. enum: - AUTH - FDET - FSUM - ILEV PartyIdentification135: type: object properties: Nm: type: object description: >- Name by which a party is known and which is usually used to identify that party. allOf: - $ref: '#/components/schemas/Max140Text' PstlAdr: type: object description: >- Information that locates and identifies a specific address, as defined by postal services. allOf: - $ref: '#/components/schemas/PostalAddress24' Id: type: object description: >- Unique and unambiguous identification of a party. Should pass EITHER OrgId or PrvtId for organisation and private respectively. allOf: - $ref: '#/components/schemas/Party38Choice' CtryOfRes: type: object description: >- Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. allOf: - $ref: '#/components/schemas/CountryCode' CtctDtls: type: object description: Set of elements used to indicate how to contact the party. allOf: - $ref: '#/components/schemas/Contact4' NamePrefix2Code: type: string description: >- Specifies the terms used to formally address a person.

DOCT : Title of the person is Doctor or Dr.

MIST : Title of the person is Mister or Mr.

MISS : Title of the person is Miss.

MADM : Title of the person is Madam.

MIKS : Title of the person is Gender Neutral. enum: - DOCT - MIST - MISS - MADM - MIKS Contact4: type: object properties: NmPrfx: type: object allOf: - $ref: '#/components/schemas/NamePrefix2Code' Nm: type: object description: >- Name by which a party is known and which is usually used to identify that party. allOf: - $ref: '#/components/schemas/Max140Text' PhneNb: type: object description: >- Collection of information that identifies a phone number, as defined by telecom services. allOf: - $ref: '#/components/schemas/PhoneNumber' MobNb: type: object description: >- Collection of information that identifies a mobile phone number, as defined by telecom services. allOf: - $ref: '#/components/schemas/PhoneNumber' FaxNb: type: object description: >- Collection of information that identifies a FAX number, as defined by telecom services. allOf: - $ref: '#/components/schemas/PhoneNumber' EmailAdr: type: object description: Address for electronic mail (e-mail). allOf: - $ref: '#/components/schemas/Max2048Text' EmailPurp: maxLength: 35 minLength: 1 type: string description: Purpose for which an email address may be used. JobTitl: maxLength: 35 minLength: 1 type: string description: Title of the function. Rspnsblty: maxLength: 35 minLength: 1 type: string description: Role of a person in an organisation. Dept: maxLength: 70 minLength: 1 type: string description: Identification of a division of a large organisation or building. Othr: type: array description: >- Contact details in another form.Communication device number or electronic address used for communication. items: $ref: '#/components/schemas/OtherContact1' PrefrdMtd: type: object allOf: - $ref: '#/components/schemas/PreferredContactMethod1Code' description: Set of elements used to indicate how to contact the party. PreferredContactMethod1Code: type: string description: >- Preferred method used to reach the individual contact within an organisation.

LETT : Preferred method used to reach the contact is per letter.

FAXX : Preferred method used to reach the contact is per fax.

PHON : Preferred method used to reach the contact is per phone.

MAIL : Preferred method used to reach the contact is per Email .

CELL : Preferred method used to reach the contact is per mobile or cell phone. enum: - LETT - FAXX - PHON - MAIL - CELL OtherContact1: required: - ChanlTp type: object properties: ChanlTp: maxLength: 4 minLength: 1 type: string description: >- Method used to contact the financial institution’s contact for the specific tax region. Id: maxLength: 128 minLength: 1 type: string description: Communication value such as phone number or email address. PhoneNumber: pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} type: string Party38Choice: type: object properties: OrgId: type: object allOf: - $ref: '#/components/schemas/OrganisationIdentification29' PrvtId: type: object allOf: - $ref: '#/components/schemas/PersonIdentification13' description: >- Either of Organisation Identification or Private Identification is required OrganisationIdentification29: type: object properties: AnyBIC: 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).Only a valid Business identifier code is allowed. Business identifier codes for financial or non-financial institutions are registered and published by the ISO 9362 Registration Authority in the ISO directory of BICs, and consists of eight (8) or eleven (11) contiguous characters. LEI: pattern: '[A-Z0-9]{18,18}[0-9]{2,2}' type: string description: >- Legal entity identification as an alternate identification for a party.Legal Entity Identifier is a code allocated to a party as described in ISO 17442. Financial Services - Legal Entity Identifier (LEI) Othr: type: array description: >- Unique identification of an organisation, as assigned by an institution, using an identification scheme.Information related to an identification of an organisation. items: $ref: '#/components/schemas/GenericOrganisationIdentification1' description: Unique and unambiguous way to identify an organisation. GenericOrganisationIdentification1: required: - Id type: object properties: Id: maxLength: 35 minLength: 1 type: string SchmeNm: type: object allOf: - $ref: '#/components/schemas/OrganisationIdentificationSchemeName1Choice' Issr: maxLength: 35 minLength: 1 type: string description: >- Unique identification of an organisation, as assigned by an institution, using an identification scheme. OrganisationIdentificationSchemeName1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external organisation identification scheme name code 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. Prtry: maxLength: 35 minLength: 1 type: string description: Description for Proprietary description: >- Name of the identification scheme.Sets of elements to identify a name of the organisation identification scheme. Either Code or Proprietary is required PersonIdentification13: type: object properties: DtAndPlcOfBirth: $ref: '#/components/schemas/DateAndPlaceOfBirth1' Othr: type: array description: >- Unique identification of a person, as assigned by an institution, using an identification scheme. items: $ref: '#/components/schemas/GenericPersonIdentification1' description: >- Unique and unambiguous identification of a person, for example a passport. DateAndPlaceOfBirth1: required: - BirthDt - CityOfBirth - CtryOfBirth type: object properties: BirthDt: type: object description: Date on which a person is born. allOf: - $ref: '#/components/schemas/ISODate' PrvcOfBirth: type: object description: Province where a person was born. allOf: - $ref: '#/components/schemas/Max35Text' CityOfBirth: type: object description: City where a person was born. allOf: - $ref: '#/components/schemas/Max35Text' CtryOfBirth: type: object description: >- Country where a person was born.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). allOf: - $ref: '#/components/schemas/CountryCode' description: Date and place of birth of a person. GenericPersonIdentification1: required: - Id type: object properties: Id: maxLength: 35 minLength: 1 type: string description: Unique and unambiguous identification of a person. Issr: maxLength: 35 minLength: 1 type: string description: Entity that assigns the identification. SchmeNm: type: object description: >- Name of the identification scheme.Sets of elements to identify a name of the identification scheme. Either Code or Proprietary is required allOf: - $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice' description: >- Unique identification of a person, as assigned by an institution, using an identification scheme. PersonIdentificationSchemeName1Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Specifies the external person identification scheme name code 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. Prtry: maxLength: 35 minLength: 1 type: string description: Description of Propreitary description: Either Code or Proprietary is required ISODate: type: string format: date Max2048Text: maxLength: 2048 minLength: 1 type: string Max140Text: maxLength: 140 minLength: 1 type: string PostalAddress24: type: object properties: AdrLine: maxItems: 7 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. items: type: string AdrTp: type: object description: >- Identifies the nature of the postal address.Either Code or Proprietary is required allOf: - $ref: '#/components/schemas/AddressType3Choice' BldgNm: maxLength: 35 minLength: 1 type: string description: Name of the building or house. BldgNb: type: object description: Number that identifies the position of a building on a street. allOf: - $ref: '#/components/schemas/Max16Text' Ctry: $ref: '#/components/schemas/CountryCode' CtrySubDvsn: type: object description: Identifies a subdivision of a country such as state, region, county. allOf: - $ref: '#/components/schemas/Max35Text' Dept: type: object description: Identification of a division of a large organisation or building. allOf: - $ref: '#/components/schemas/Max70Text' PstCd: type: object description: >- Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. allOf: - $ref: '#/components/schemas/Max16Text' StrtNm: type: object description: Name of a street or thoroughfare. allOf: - $ref: '#/components/schemas/Max70Text' SubDept: type: object description: >- Identification of a sub-division of a large organisation or building. allOf: - $ref: '#/components/schemas/Max70Text' TwnNm: type: object description: >- Name of a built-up area, with defined boundaries, and a local government. allOf: - $ref: '#/components/schemas/Max35Text' TwnLctnNm: maxLength: 35 minLength: 1 type: string description: Specific location name within the town. PstBx: maxLength: 16 minLength: 1 type: string description: >- Name of a built-up area, with defined boundaries, and a local government. Flr: maxLength: 70 minLength: 1 type: string description: Floor or storey within a building. Room: maxLength: 70 minLength: 1 type: string description: Building room number. DstrctNm: maxLength: 35 minLength: 1 type: string description: Identifies a subdivision within a country sub-division. description: >- Information that locates and identifies a specific address, as defined by postal services. CountryCode: pattern: '[A-Z]{2,2}' type: string description: >- Nation with its own government. The code is checked against the list of country names obtained from the United Nations (ISO 3166, Alpha-2 code). AddressType3Choice: type: object properties: Cd: type: object description: >- Specifies the type of address.

ADDR : Address is the complete postal address.

PBOX : Address is a postal office (PO) box.

HOME : Address is the home address.

BIZZ : Address is the business address.

MLTO : Address is the address to which mail is sent.

DLVY : Address is the address to which delivery is to take place. allOf: - $ref: '#/components/schemas/AddressType2Code' Prtry: type: object description: >- Information related to an identification, for example, party identification or account identification. allOf: - $ref: '#/components/schemas/GenericIdentification30' description: Either from Code or Proprietary is required GenericIdentification30: required: - Id - Issr type: object properties: Id: pattern: '[a-zA-Z0-9]{4}' type: string description: >- Proprietary information, often a code, issued by the data source scheme issuer. Issr: maxLength: 35 minLength: 1 type: string description: Entity that assigns the identification. SchmeNm: maxLength: 35 minLength: 1 type: string description: Short textual description of the scheme. AddressType2Code: type: string description: >-

ADDR : Address is the complete postal address.

PBOX : Address is a postal office (PO) box.

HOME : Address is the home address.

BIZZ : Address is the business address.

MLTO : Address is the address to which mail is sent.

DLVY : Address is the address to which delivery is to take place. enum: - ADDR - PBOX - HOME - BIZZ - MLTO - DLVY Max70Text: maxLength: 70 minLength: 1 type: string Max35Text: maxLength: 35 minLength: 1 type: string Max16Text: maxLength: 16 minLength: 1 type: string CustomerDirectDebitInitiationV02: required: - GrpHdr - PmtInf type: object properties: GrpHdr: $ref: '#/components/schemas/GroupHeader39' PmtInf: minItems: 1 type: array description: >- Set of characteristics that apply to the debit side of the payment transactions included in the credit transfer initiation. items: $ref: '#/components/schemas/PaymentInstructionInformation4' description: >- The CustomerDirectDebitInitiation message is sent by the initiating party to the forwarding agent or creditor agent. It is used to request single or bulk collection(s) of funds from one or various debtor's account(s) for a creditor. BranchAndFinancialInstitutionIdentification4: required: - FinInstnId type: object properties: BrnchId: $ref: '#/components/schemas/BranchData2' FinInstnId: $ref: '#/components/schemas/FinancialInstitutionIdentification7' BranchData2: type: object properties: Id: type: object description: >- Unique and unambiguous identification of a branch of a financial institution. allOf: - $ref: '#/components/schemas/Max35Text' Nm: type: object description: >- Name by which an agent is known and which is usually used to identify that agent. allOf: - $ref: '#/components/schemas/Max140Text' PstlAdr: $ref: '#/components/schemas/PostalAddress6' description: Identifies a specific branch of a financial institution. CashAccount16: required: - Id type: object properties: Ccy: type: object description: Identification of the currency in which the account is held. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' Id: $ref: '#/components/schemas/AccountIdentification4Choice' Nm: type: object 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. allOf: - $ref: '#/components/schemas/Max70Text' Tp: $ref: '#/components/schemas/CashAccountType2' CashAccountType2: type: object properties: Cd: $ref: '#/components/schemas/CashAccountType4Code' Prtry: type: object description: Nature or use of the account in a proprietary form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Specifies the nature, or use of the account. Either Code or Proprietary field value should be passed on request. CashAccountType4Code: type: string description: >- Account type, in a coded form.

CASH : Account used for the payment of cash.

CHAR : Account used for charges if different from the account for payment.

COMM : Account used for commission if different from the account for payment.

TAXE : Account used for taxes if different from the account for payment.

CISH : Account used for payment of income if different from the current cash account.

TRAS : Account used for trading if different from the current cash account.

SACC : Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.

CACC : Account used to post debits and credits when no specific account has been nominated.

SVGS : Account used for savings.

ONDP : Account used for overnight deposits.

MGLD : Account used for a marginal lending facility.

NREX : Account used for non-resident external.

MOMA : Account used for money markets if different from the cash account.

LOAN : Account used for loans.

SLRY : Accounts used for salary payments.

ODFT : Account is used for overdrafts. enum: - CASH - CHAR - COMM - TAXE - CISH - TRAS - SACC - CACC - SVGS - ONDP - MGLD - NREX - MOMA - LOAN - SLRY - ODFT DirectDebitTransaction6: type: object properties: MndtRltdInf: $ref: '#/components/schemas/MandateRelatedInformation6' CdtrSchmeId: type: object description: Credit party that signs the mandate. allOf: - $ref: '#/components/schemas/PartyIdentification32' PreNtfctnId: type: object description: >- Unique and unambiguous identification of the pre-notification which is sent separately from the direct debit instruction. allOf: - $ref: '#/components/schemas/Max35Text' PreNtfctnDt: type: object description: >- Date on which the creditor notifies the debtor about the amount and date on which the direct debit instruction will be presented to the debtor's agent. allOf: - $ref: '#/components/schemas/ISODate' description: >- Set of elements providing information specific to the direct debit mandate. DirectDebitTransactionInformation9: required: - DbtrAcct - DbtrAgt - InstdAmt - PmtId type: object properties: PmtId: $ref: '#/components/schemas/PaymentIdentification1' PmtTpInf: $ref: '#/components/schemas/PaymentTypeInformation20' InstdAmt: type: object description: >- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' ChrgBr: $ref: '#/components/schemas/ChargeBearerType1Code' DrctDbtTx: $ref: '#/components/schemas/DirectDebitTransaction6' UltmtCdtr: type: object description: Ultimate party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' Dbtr: type: object description: Party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' DbtrAcct: type: object description: >- Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. allOf: - $ref: '#/components/schemas/CashAccount16' DbtrAgt: type: object description: Financial institution servicing an account for the debtor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 DbtrAgtAcct: type: object description: >- Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' UltmtDbtr: type: object description: >- Ultimate party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' InstrForCdtrAgt: type: object description: >- Further information, related to the processing of the payment instruction, that may need to be acted upon by the creditor agent, depending on agreement between creditor and the creditor agent. allOf: - $ref: '#/components/schemas/Max140Text' Purp: $ref: '#/components/schemas/Purpose2Choice' RgltryRptg: maxItems: 10 type: array description: Information needed due to regulatory and statutory requirements. items: $ref: '#/components/schemas/RegulatoryReporting3' Tax: $ref: '#/components/schemas/TaxInformation3' RltdRmtInf: maxItems: 10 type: array description: >- Set of elements used to provide information related to the handling of the remittance information by any of the agents in the transaction processing chain. items: $ref: '#/components/schemas/RemittanceLocation2' RmtInf: type: object description: >- Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. allOf: - $ref: '#/components/schemas/RemittanceInformation5' GroupHeader39: required: - CreDtTm - InitgPty - MsgId - NbOfTxs type: object properties: CtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the message, irrespective of currencies. The number of fractional digits should not be more than 17. CreDtTm: type: string description: Date and time at which the message was created. format: date-time FwdgAgt: type: object description: >- Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 InitgPty: type: object description: >- Party that initiates the payment. This can either be the debtor or the party that initiates the credit transfer on behalf of the debtor. allOf: - $ref: '#/components/schemas/PartyIdentification32' MsgId: maxLength: 35 minLength: 1 type: string description: >- Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. NbOfTxs: type: object description: Number of individual transactions contained in the message. allOf: - $ref: '#/components/schemas/Max15NumericText' Authstn: maxItems: 2 type: array description: >- User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message. items: $ref: '#/components/schemas/Authorisation1Choice' description: >- Group header details. Set of characteristics shared by all individual transactions included in the message. PaymentInstructionInformation4: required: - Cdtr - CdtrAcct - CdtrAgt - DrctDbtTxInf - PmtInfId - PmtMtd - ReqdColltnDt type: object properties: BtchBookg: type: boolean description: >- Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested. ChrgBr: $ref: '#/components/schemas/ChargeBearerType1Code' ChrgsAcct: type: object description: Account used to process charges associated with a transaction. allOf: - $ref: '#/components/schemas/CashAccount16' ChrgsAcctAgt: type: object description: Agent that services a charges account. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 CtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the group, irrespective of currencies. The number of fractional digits should not be more than 17. DrctDbtTxInf: minItems: 1 type: array description: >- Set of elements used to provide information on the individual transaction(s) included in the message. items: $ref: '#/components/schemas/DirectDebitTransactionInformation9' Cdtr: type: object description: Party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' CdtrAcct: type: object description: >- Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount16' CdtrAgt: type: object description: Financial institution servicing an account for the creditor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 CdtrAgtAcct: type: object description: >- Unambiguous identification of the account of the creditor agent at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' NbOfTxs: pattern: '[0-9]{1,15}' type: string description: >- Number of individual transactions contained in the paymnet information group. PmtInfId: type: object description: >- Unique identification, as assigned by a sending party, to unambiguously identify the payment information group within the message. allOf: - $ref: '#/components/schemas/Max35Text' PmtMtd: type: string description: >- Specifies the means of payment that will be used to move the amount of money.

DD : Collection of an amount of money from the debtor's bank account by the creditor. The amount of money and dates of collections may vary. enum: - DD PmtTpInf: $ref: '#/components/schemas/PaymentTypeInformation20' CdtrSchmeId: type: object description: Credit party that signs the mandate. allOf: - $ref: '#/components/schemas/PartyIdentification32' ReqdColltnDt: type: string description: >- Date and time at which the creditor requests that the amount of money is to be collected from the debtor. format: date UltmtCdtr: type: object description: Ultimate party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' PaymentTypeInformation20: type: object properties: CtgyPurp: $ref: '#/components/schemas/CategoryPurpose1Choice' InstrPrty: $ref: '#/components/schemas/Priority2Code' LclInstrm: $ref: '#/components/schemas/LocalInstrument2Choice' SvcLvl: $ref: '#/components/schemas/ServiceLevel8Choice' SeqTp: $ref: '#/components/schemas/SequenceType1Code' description: Set of elements used to further specify the type of transaction. SequenceType1Code: type: string description: >- Identifies the direct debit sequence, such as first, recurrent, final or one-off.

FRST : First collection of a series of direct debit instructions.

RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.

FNAL : Final collection of a series of direct debit instructions.

OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction. enum: - FRST - RCUR - FNAL - OOFF AmountType3Choice: type: object properties: EqvtAmt: $ref: '#/components/schemas/EquivalentAmount2' InstdAmt: type: object description: >- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: >- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Either EqvtAmt or InstdAmt field value should be passed on request. BaseOneRate: maxLength: 11 type: string description: >- The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. Cheque6: type: object properties: ChqFr: type: object description: Identifies the party that ordered the issuance of the cheque. allOf: - $ref: '#/components/schemas/NameAndAddress10' ChqMtrtyDt: type: object description: >- Date when the draft becomes payable and the debtor's account is debited. allOf: - $ref: '#/components/schemas/ISODate' ChqNb: type: object description: >- Unique and unambiguous identifier for a cheque as assigned by the agent. allOf: - $ref: '#/components/schemas/Max35Text' ChqTp: $ref: '#/components/schemas/ChequeType2Code' DlvrTo: type: object description: Party to whom the debtor's agent needs to send the cheque. allOf: - $ref: '#/components/schemas/NameAndAddress10' DlvryMtd: $ref: '#/components/schemas/ChequeDeliveryMethod1Choice' FrmsCd: type: object description: >- Identifies, in a coded form, the cheque layout, company logo and digitised signature to be used to print the cheque, as agreed between the initiating party and the debtor's agent. allOf: - $ref: '#/components/schemas/Max35Text' InstrPrty: type: object description: >- Urgency or order of importance that the originator would like the recipient of the payment instruction to apply to the processing of the payment instruction.

HIGH : Priority level is high.

NORM : Priority level is normal. allOf: - $ref: '#/components/schemas/Priority2Code' MemoFld: maxItems: 2 type: array description: >- Information that needs to be printed on a cheque, used by the payer to add miscellaneous information. items: $ref: '#/components/schemas/Max35Text' PrtLctn: type: object description: Specifies the print location of the cheque. allOf: - $ref: '#/components/schemas/Max35Text' RgnlClrZone: type: object description: >- Regional area in which the cheque can be cleared, when a country has no nation-wide cheque clearing organisation. allOf: - $ref: '#/components/schemas/Max35Text' description: Set of elements needed to issue a cheque. ChequeDelivery1Code: type: string description: >- Specifies the delivery method of the cheque by the debtor's agent.

MLDB : Cheque is to be sent through mail services to debtor.

MLCD : Cheque is to be sent through mail services to creditor.

MLFA : Cheque is to be sent through mail services to creditor agent.

CRDB : Cheque is to be sent through courier services to debtor.

CRCD : Cheque is to be sent through courier services to creditor.

CRFA : Cheque is to be sent through courier services to creditor agent.

PUDB : Cheque will be picked up by the debtor.

PUCD : Cheque will be picked up by the creditor.

PUFA : Cheque will be picked up by the creditor agent.

RGDB : Cheque is to be sent through registered mail services to debtor.

RGCD : Cheque is to be sent through registered mail services to creditor.

RGFA : Cheque is to be sent through registered mail services to creditor agent. enum: - MLDB - MLCD - MLFA - CRDB - CRCD - CRFA - PUDB - PUCD - PUFA - RGDB - RGCD - RGFA ChequeDeliveryMethod1Choice: type: object properties: Cd: $ref: '#/components/schemas/ChequeDelivery1Code' Prtry: type: object description: >- Specifies a proprietary delivery method of the cheque by the debtor's agent. allOf: - $ref: '#/components/schemas/Max35Text' description: Specifies the delivery method of the cheque by the debtor's agent. ChequeType2Code: type: string description: >- Specifies the type of cheque to be issued.

CCHQ : Cheque drawn on the account of the debtor, and debited on the debtor's account when the cheque is cashed. Synonym is 'corporate cheque'.

CCCH : Cheque drawn on the account of the debtor, and debited on the debtor's account when the cheque is cashed. The financial institution prints and certifies the cheque, guaranteeing the payment.

BCHQ : Cheque drawn on the account of the debtor's financial institution, which is debited on the debtor's account when the cheque is issued.These cheques are printed by the debtor's financial institution and payment is guaranteed by the financial institution. Synonym is 'cashier's cheque'.

DRFT : A guaranteed bank cheque with a future value date (do not pay before], which in commercial terms is a 'negotiatable instrument': the beneficiary can receive early payment from any bank under subtraction of a discount. The ordering customer's account is debited on value date.

ELDR : An instrument with a future value date (do not pay before], which in commercial terms is a 'negotiatable instrument': the beneficiary can receive early payment from any bank under subtraction of a discount. The ordering customer's account is debited on value date. enum: - CCHQ - CCCH - BCHQ - DRFT - ELDR ContactDetails2: type: object properties: EmailAdr: type: object description: Address for electronic mail (e-mail). allOf: - $ref: '#/components/schemas/Max2048Text' FaxNb: type: object description: >- Collection of information that identifies a FAX number, as defined by telecom services. allOf: - $ref: '#/components/schemas/PhoneNumber' MobNb: type: object description: >- Collection of information that identifies a mobile phone number, as defined by telecom services. allOf: - $ref: '#/components/schemas/PhoneNumber' Nm: type: object description: >- Name by which a party is known and which is usually used to identify that party. allOf: - $ref: '#/components/schemas/Max140Text' NmPrfx: $ref: '#/components/schemas/NamePrefix1Code' Othr: type: object description: Contact details in another form. allOf: - $ref: '#/components/schemas/Max35Text' PhneNb: type: object description: >- Collection of information that identifies a phone number, as defined by telecom services. allOf: - $ref: '#/components/schemas/PhoneNumber' description: Set of elements used to indicate how to contact the party. CreditTransferTransactionInformation10: required: - Amt - PmtId type: object properties: Amt: $ref: '#/components/schemas/AmountType3Choice' ChrgBr: $ref: '#/components/schemas/ChargeBearerType1Code' ChqInstr: $ref: '#/components/schemas/Cheque6' Cdtr: type: object description: Party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' CdtrAcct: type: object description: >- Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount16' CdtrAgt: type: object description: Financial institution servicing an account for the creditor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 CdtrAgtAcct: type: object description: >- Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount16' XchgRateInf: $ref: '#/components/schemas/ExchangeRateInformation1' InstrForCdtrAgt: type: array description: >- Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. items: $ref: '#/components/schemas/InstructionForCreditorAgent1' InstrForDbtrAgt: type: object description: >- Further information related to the processing of the payment instruction, that may need to be acted upon by the debtor agent, depending on agreement between debtor and the debtor agent. allOf: - $ref: '#/components/schemas/Max140Text' IntrmyAgt1: type: object description: Agent between the debtor's agent and the creditor's agent. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 IntrmyAgt1Acct: type: object description: >- Unambiguous identification of the account of the intermediary agent 1 at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' IntrmyAgt2: type: object description: Agent between the debtor's agent and the creditor's agent. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 IntrmyAgt2Acct: type: object description: >- Unambiguous identification of the account of the intermediary agent 2 at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' IntrmyAgt3: type: object description: Agent between the debtor's agent and the creditor's agent. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 IntrmyAgt3Acct: type: object description: >- Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' PmtId: $ref: '#/components/schemas/PaymentIdentification1' PmtTpInf: $ref: '#/components/schemas/PaymentTypeInformation19' Purp: $ref: '#/components/schemas/Purpose2Choice' RgltryRptg: maxItems: 10 type: array description: Information needed due to regulatory and statutory requirements. items: $ref: '#/components/schemas/RegulatoryReporting3' RltdRmtInf: maxItems: 10 type: array description: >- Set of elements used to provide information related to the handling of the remittance information by any of the agents in the transaction processing chain. items: $ref: '#/components/schemas/RemittanceLocation2' RmtInf: type: object description: >- Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. allOf: - $ref: '#/components/schemas/RemittanceInformation5' Tax: $ref: '#/components/schemas/TaxInformation3' UltmtCdtr: type: object description: Ultimate party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' UltmtDbtr: type: object description: >- Ultimate party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' CustomerCreditTransferInitiationV03: required: - GrpHdr - PmtInf type: object properties: GrpHdr: $ref: '#/components/schemas/GroupHeader32' PmtInf: minItems: 1 type: array description: >- Set of characteristics that apply to the debit side of the payment transactions included in the credit transfer initiation. items: $ref: '#/components/schemas/PaymentInstructionInformation3' description: >- The CustomerCreditTransferInitiation message is sent by the initiating party to the forwarding agent or debtor agent. It is used to request movement of funds from the debtor account to a creditor. CustomerPaymentStatusReportV03: required: - GrpHdr - OrgnlGrpInfAndSts type: object properties: GrpHdr: $ref: '#/components/schemas/GroupHeader36' OrgnlGrpInfAndSts: $ref: '#/components/schemas/OriginalGroupInformation20' OrgnlPmtInfAndSts: type: array description: >- Information concerning the original payment information, to which the status report message refers. items: $ref: '#/components/schemas/OriginalPaymentInformation1' OriginalGroupInformation20: required: - OrgnlMsgId - OrgnlMsgNmId type: object properties: OrgnlMsgId: type: object description: >- Point to point reference, as assigned by the original instructing party, to unambiguously identify the original message. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlMsgNmId: type: object description: >- Specifies the original message name identifier to which the message refers. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlCreDtTm: type: string description: Date and time at which the original message was created. format: date-time OrgnlNbOfTxs: type: object description: Number of individual transactions contained in the original message. allOf: - $ref: '#/components/schemas/Max15NumericText' OrgnlCtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the original message, irrespective of currencies. The number of fractional digits should not be more than 17. GrpSts: $ref: '#/components/schemas/TransactionGroupStatus3Code' StsRsnInf: type: array description: >- Set of elements used to provide detailed information on the status reason. items: $ref: '#/components/schemas/StatusReasonInformation8' NbOfTxsPerSts: type: array description: >- Detailed information on the number of transactions for each identical transaction status. items: $ref: '#/components/schemas/NumberOfTransactionsPerStatus3' description: >- Original group information concerning the group of transactions, to which the status report message refers to. OriginalPaymentInformation1: required: - OrgnlPmtInfId type: object properties: OrgnlPmtInfId: type: object description: >- Unique identification, as assigned by the original sending party, to unambiguously identify the original payment information group. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlNbOfTxs: type: object description: >- Number of individual transactions contained in the original payment information group. allOf: - $ref: '#/components/schemas/Max15NumericText' OrgnlCtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the original payment information group, irrespective of currencies. The number of fractional digits should not be more than 17. PmtInfSts: type: object description: >- Specifies the status of the payment information group.

ACTC : Authentication and syntactical and semantical validation are successful.

RCVD : Payment initiation has been received by the receiving agent.

PART : A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status.

RJCT : Payment initiation or individual transaction included in the payment initiation has been rejected.

PDNG : Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.

ACCP : Preceding check of technical validation was successful. Customer profile check was also successful.

ACSP : All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.

ACSC : Settlement on the debtor's account has been completed. Usage : this can be used by the first agent to report to the debtor that the transaction has been completed. Warning : this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement

ACWC : Instruction is accepted but a change will be made, such as date or remittance not sent. allOf: - $ref: '#/components/schemas/TransactionGroupStatus3Code' StsRsnInf: type: array description: >- Set of elements used to provide detailed information on the status reason. items: $ref: '#/components/schemas/StatusReasonInformation8' NbOfTxsPerSts: type: array description: >- Detailed information on the number of transactions for each identical transaction status. items: $ref: '#/components/schemas/NumberOfTransactionsPerStatus3' TxInfAndSts: type: array description: Payment transaction information and status. items: $ref: '#/components/schemas/PaymentTransactionInformation25' StatusReasonInformation8: type: object properties: Orgtr: type: object description: Party that issues the status. allOf: - $ref: '#/components/schemas/PartyIdentification32' Rsn: $ref: '#/components/schemas/StatusReason6Choice' AddtlInf: type: array description: Further details on the status reason. items: $ref: '#/components/schemas/Max105Text' StatusReason6Choice: type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: Reason for the status, as published in an external reason code list. Prtry: type: object description: Reason for the status, in a proprietary form. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Specifies the reason for the status report. Either Code or Proprietary field value should be passed on request. NumberOfTransactionsPerStatus3: required: - DtldNbOfTxs - DtldSts type: object properties: DtldNbOfTxs: type: object description: >- Number of individual transactions contained in the message, detailed per status. allOf: - $ref: '#/components/schemas/Max15NumericText' DtldCtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the message, irrespective of currencies, detailed per status. The number of fractional digits should not be more than 17 DtldSts: $ref: '#/components/schemas/TransactionIndividualStatus3Code' TransactionIndividualStatus3Code: type: string description: >- Common transaction status for all individual transactions reported.

ACTC : Authentication and syntactical and semantical validation are successful.

RJCT : Payment initiation or individual transaction included in the payment initiation has been rejected.

PDNG : Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.

ACCP : Preceding check of technical validation was successful. Customer profile check was also successful.

ACSP : All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.

ACSC : Settlement on the debtor's account has been completed. Usage : this can be used by the first agent to report to the debtor that the transaction has been completed. Warning : this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement

ACWC : Instruction is accepted but a change will be made, such as date or remittance not sent. enum: - ACTC - RJCT - PDNG - ACCP - ACSP - ACSC - ACWC TransactionGroupStatus3Code: type: string description: >- Specifies the status of a group of transactions.

ACTC : Authentication and syntactical and semantical validation are successful.

RCVD : Payment initiation has been received by the receiving agent.

PART : A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status.

RJCT : Payment initiation or individual transaction included in the payment initiation has been rejected.

PDNG : Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.

ACCP : Preceding check of technical validation was successful. Customer profile check was also successful.

ACSP : All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.

ACSC : Settlement on the debtor's account has been completed. Usage : this can be used by the first agent to report to the debtor that the transaction has been completed. Warning : this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement

ACWC : Instruction is accepted but a change will be made, such as date or remittance not sent. enum: - ACTC - RCVD - PART - RJCT - PDNG - ACCP - ACSP - ACSC - ACWC PaymentTransactionInformation25: type: object properties: StsId: type: object description: >- Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the reported status. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlInstrId: type: object description: >- Unique identification, as assigned by the original instructing party for the original instructed party, to unambiguously identify the original instruction. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlEndToEndId: type: object description: >- Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction. allOf: - $ref: '#/components/schemas/Max35Text' TxSts: $ref: '#/components/schemas/TransactionIndividualStatus3Code' StsRsnInf: type: array description: >- Set of elements used to provide detailed information on the status reason. items: $ref: '#/components/schemas/StatusReasonInformation8' ChrgsInf: type: array description: >- Provides information on the charges related to the processing of the rejection of the instruction. items: $ref: '#/components/schemas/ChargesInformation5' AccptncDtTm: type: string description: >- Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorisation, availability of funds. format: date-time AcctSvcrRef: type: object description: >- Unique reference, as assigned by the account servicing institution, to unambiguously identify the instruction. allOf: - $ref: '#/components/schemas/Max35Text' ClrSysRef: type: object description: >- Unique reference, as assigned by a clearing system, to unambiguously identify the instruction. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlTxRef: $ref: '#/components/schemas/OriginalTransactionReference13' ChargesInformation5: required: - Amt - Pty type: object properties: Amt: type: object description: Transaction charges to be paid by the charge bearer. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Pty: type: object description: >- Party that takes the transaction charges or to which the transaction charges are due. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 OriginalTransactionReference13: type: object properties: IntrBkSttlmAmt: type: object description: >- Amount of money moved between the instructing agent and the instructed agent. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Amt: $ref: '#/components/schemas/AmountType3Choice' IntrBkSttlmDt: type: string description: >- Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. format: date ReqdColltnDt: type: string description: >- Date on which the creditor requests that the amount of money is to be collected from the debtor. format: date ReqdExctnDt: type: string description: >- Date at which the initiating party requests the clearing agent to process the payment. format: date CdtrSchmeId: type: object description: Credit party that signs the mandate. allOf: - $ref: '#/components/schemas/PartyIdentification32' SttlmInf: $ref: '#/components/schemas/SettlementInformation13' PmtTpInf: $ref: '#/components/schemas/PaymentTypeInformation22' PmtMtd: $ref: '#/components/schemas/PaymentMethod4Code' MndtRltdInf: $ref: '#/components/schemas/MandateRelatedInformation6' RmtInf: $ref: '#/components/schemas/RemittanceInformation5' UltmtDbtr: type: object description: >- Ultimate party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' Dbtr: type: object description: Party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' DbtrAcct: type: object description: >- Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. allOf: - $ref: '#/components/schemas/CashAccount16' DbtrAgt: type: object description: Financial institution servicing an account for the debtor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 DbtrAgtAcct: type: object description: >- Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' CdtrAgt: type: object description: Financial institution servicing an account for the creditor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 CdtrAgtAcct: type: object description: >- Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount16' Cdtr: type: object description: Party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' CdtrAcct: type: object description: >- Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. allOf: - $ref: '#/components/schemas/CashAccount16' UltmtCdtr: type: object description: Ultimate party to which an amount of money is due. allOf: - $ref: '#/components/schemas/PartyIdentification32' description: >- Set of key elements used to identify the original transaction that is being referred to. SettlementInformation13: required: - SttlmMtd type: object properties: SttlmMtd: $ref: '#/components/schemas/SettlementMethod1Code' SttlmAcct: type: object description: >- A specific purpose account used to post debit and credit entries as a result of the transaction. allOf: - $ref: '#/components/schemas/CashAccount16' InstgRmbrsmntAgtAcct: type: object description: >- Unambiguous identification of the account of the instructing reimbursement agent account at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' InstdRmbrsmntAgtAcct: type: object description: >- Unambiguous identification of the account of the instructed reimbursement agent account at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' ThrdRmbrsmntAgtAcct: type: object description: >- Unambiguous identification of the account of the third reimbursement agent account at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' InstgRmbrsmntAgt: type: object description: >- Agent through which the instructing agent will reimburse the instructed agent. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 InstdRmbrsmntAgt: type: object description: Agent at which the instructed agent will be reimbursed. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 ThrdRmbrsmntAgt: type: object description: Agent at which the instructed agent will be reimbursed. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 ClrSys: $ref: '#/components/schemas/ClearingSystemIdentification3Choice' description: >- Specifies the details on how the settlement of the original transaction(s) between the instructing agent and the instructed agent was completed. PaymentTypeInformation22: type: object properties: InstrPrty: $ref: '#/components/schemas/Priority2Code' ClrChanl: type: string description: >- Specifies the clearing channel to be used to process the payment instruction.

RTGS : Clearing channel is a real-time gross settlement system.

RTNS : Clearing channel is a real-time net settlement system.

MPNS : Clearing channel is a mass payment net settlement system.

BOOK : Payment through internal book transfer. enum: - RTGS - RTNS - MPNS - BOOK SvcLvl: $ref: '#/components/schemas/ServiceLevel8Choice' LclInstrm: $ref: '#/components/schemas/LocalInstrument2Choice' SeqTp: type: string description: >- Identifies the direct debit sequence, such as first, recurrent, final or one-off.

FRST : First collection of a series of direct debit instructions.

RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.

FNAL : Final collection of a series of direct debit instructions.

OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction. enum: - FRST - RCUR - FNAL - OOFF CtgyPurp: $ref: '#/components/schemas/CategoryPurpose1Choice' description: Set of elements used to further specify the type of transaction. MandateRelatedInformation6: type: object properties: MndtId: type: object description: >- Unique identification, as assigned by the creditor, to unambiguously identify the mandate. allOf: - $ref: '#/components/schemas/Max35Text' AmdmntInd: type: boolean description: >- Indicator notifying whether the underlying mandate is amended or not. AmdmntInfDtls: $ref: '#/components/schemas/AmendmentInformationDetails6' ElctrncSgntr: maxLength: 1025 minLength: 1 type: string description: >- Additional security provisions, such as a digital signature, as provided by the debtor. DtOfSgntr: type: string description: >- Date on which the direct debit mandate has been signed by the debtor. format: date FrstColltnDt: type: string description: Date of the first collection of a direct debit as per the mandate. format: date FnlColltnDt: type: string description: Date of the final collection of a direct debit as per the mandate. format: date Frqcy: $ref: '#/components/schemas/Frequency1Code' description: >- Set of elements used to provide further details of the mandate signed between the creditor and the debtor. AmendmentInformationDetails6: type: object properties: OrgnlMndtId: type: object description: >- Unique identification, as assigned by the creditor, to unambiguously identify the original mandate. allOf: - $ref: '#/components/schemas/Max35Text' OrgnlCdtrSchmeId: type: object description: Original creditor scheme identification that has been modified. allOf: - $ref: '#/components/schemas/PartyIdentification32' OrgnlDbtr: type: object description: Original debtor that has been modified. allOf: - $ref: '#/components/schemas/PartyIdentification32' OrgnlDbtrAcct: type: object description: Original debtor account that has been modified. allOf: - $ref: '#/components/schemas/CashAccount16' OrgnlDbtrAgt: type: object description: Original debtor agent that has been modified. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 OrgnlDbtrAgtAcct: type: object description: Original debtor agent account that has been modified. allOf: - $ref: '#/components/schemas/CashAccount16' OrgnlCdtrAgt: type: object description: Original creditor agent that has been modified. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 OrgnlCdtrAgtAcct: type: object description: Original creditor agent acount that has been modified. allOf: - $ref: '#/components/schemas/CashAccount16' OrgnlFnlColltnDt: type: string description: Original final collection date that has been modified. format: date OrgnlFrqcy: $ref: '#/components/schemas/Frequency1Code' description: List of mandate elements that have been modified. Frequency1Code: type: string description: >- Original frequency that has been modified.

YEAR : Event takes place every year or once a year.

MNTH : Event takes place every month or once a month.

QURT : Event takes place every three months or four times a year.

MIAN : Event takes place every six months or two times a year.

WEEK : Event takes place once a week.

DAIL : Event takes place every day.

ADHO : Event takes place on request or as necessary.

INDA : Event takes place several times a day. enum: - YEAR - MNTH - QURT - MIAN - WEEK - DAIL - ADHO - INDA DateAndPlaceOfBirth: required: - BirthDt - CityOfBirth - CtryOfBirth type: object properties: BirthDt: type: object description: Date on which a person is born. allOf: - $ref: '#/components/schemas/ISODate' PrvcOfBirth: type: object description: Province where a person was born. allOf: - $ref: '#/components/schemas/Max35Text' CityOfBirth: type: object description: City where a person was born. allOf: - $ref: '#/components/schemas/Max35Text' CtryOfBirth: type: object description: Country where a person was born. allOf: - $ref: '#/components/schemas/CountryCode' description: Date and place of birth of a person. DatePeriodDetails: required: - FrDt - ToDt type: object properties: FrDt: type: object description: Start date of the range. allOf: - $ref: '#/components/schemas/ISODate' ToDt: type: object description: End date of the range. allOf: - $ref: '#/components/schemas/ISODate' DocumentType5Code: type: string description: >- Document type in a coded form.

MSIN : Document is an invoice claiming payment for the supply of metered services, for example gas or electricity supplied to a fixed meter.

CNFA : Document is a credit note for the final amount settled for a commercial transaction.

DNFA : Document is a debit note for the final amount settled for a commercial transaction.

CINV : Document is an invoice.

CREN : Document is a credit note.

DEBN : Document is a debit note.

HIRI : Document is an invoice for the hiring of human resources or renting goods or equipment.

SBIN : Document is an invoice issued by the debtor.

SVGS : Account used for savings.

CMCN : Document is an agreement between the parties, stipulating the terms and conditions of the delivery of goods or services.

SOAC : Document is a statement of the transactions posted to the debtor's account at the supplier.

DISP : Document is a dispatch advice.

BOLD : Document is a shipping notice.

VCHR : Document is an electronic payment document.

AROI : Document is a payment that applies to a specific source document.

TSUT : Document is a transaction identifier as assigned by the Trade Services Utility. enum: - MSIN - CNFA - DNFA - CINV - CREN - DEBN - HIRI - SBIN - CMCN - SOAC - DISP - BOLD - VCHR - AROI - TSUT ExchangeRateInformation1: type: object properties: CtrctId: type: object description: >- Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. allOf: - $ref: '#/components/schemas/Max35Text' XchgRate: $ref: '#/components/schemas/BaseOneRate' RateTp: type: string description: >- Specifies the type used to complete the currency exchange.

SPOT : Exchange rate applied is the spot rate.

SALE : Exchange rate applied is the market rate at the time of the sale.

AGRD : Exchange rate applied is the rate agreed between the parties. enum: - SPOT - SALE - AGRD description: >- Set of elements used to provide details on the currency exchange rate and contract. FinancialInstitutionIdentification7: type: object properties: BIC: pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([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)". ClrSysMmbId: $ref: '#/components/schemas/ClearingSystemMemberIdentification2' Nm: type: object description: >- Name by which an agent is known and which is usually used to identify that agent. allOf: - $ref: '#/components/schemas/Max140Text' Othr: $ref: '#/components/schemas/GenericFinancialIdentification1' PstlAdr: $ref: '#/components/schemas/PostalAddress6' description: >- Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. GroupHeader32: required: - CreDtTm - InitgPty - MsgId - NbOfTxs type: object properties: CtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the message, irrespective of currencies. The number of fractional digits should not be more than 17. CreDtTm: type: string description: Date and time at which the message was created. format: date-time FwdgAgt: type: object description: >- Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 InitgPty: type: object description: >- Party that initiates the payment. This can either be the debtor or the party that initiates the credit transfer on behalf of the debtor. allOf: - $ref: '#/components/schemas/PartyIdentification32' MsgId: maxLength: 35 minLength: 1 type: string description: >- Message id. Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. NbOfTxs: type: object description: Number of individual transactions contained in the message. allOf: - $ref: '#/components/schemas/Max15NumericText' Authstn: maxItems: 2 type: array description: >- User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message. items: $ref: '#/components/schemas/Authorisation1Choice' description: >- Group header details. Set of characteristics shared by all individual transactions included in the message. GroupHeader36: required: - CreDtTm - MsgId type: object properties: CreDtTm: type: string description: Date and time at which the message was created. format: date-time FwdgAgt: type: object description: >- Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 DbtrAgt: type: object description: Financial institution servicing an account for the debtor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 CdtrAgt: type: object description: Financial institution servicing an account for the creditor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 InitgPty: type: object description: Party that initiates the status message. allOf: - $ref: '#/components/schemas/PartyIdentification32' MsgId: maxLength: 35 minLength: 1 type: string description: >- Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. description: >- Set of characteristics shared by all individual transactions included in the message. Instruction3Code: type: string description: >- Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.

CHQB : (Ultimate) creditor must be paid by cheque.

HOLD : Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.

PHOB : Please advise/contact (ultimate) creditor/claimant by phone.

TELB : Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication. enum: - CHQB - HOLD - PHOB - TELB InstructionForCreditorAgent1: type: object properties: Cd: $ref: '#/components/schemas/Instruction3Code' InstrInf: type: object description: >- Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. allOf: - $ref: '#/components/schemas/Max140Text' Max10Text: maxLength: 10 minLength: 1 type: string Max15NumericText: pattern: '[0-9]{1,15}' type: string Max34Text: maxLength: 34 minLength: 1 type: string Max105Text: maxLength: 105 minLength: 1 type: string NameAndAddress10: required: - Adr - Nm type: object properties: Adr: $ref: '#/components/schemas/PostalAddress6' Nm: type: object description: >- Name by which a party is known and is usually used to identify that party. allOf: - $ref: '#/components/schemas/Max140Text' NamePrefix1Code: type: string description: >- Specifies the terms used to formally address a person.

DOCT : Title of the person is Doctor or Dr.

MIST : Title of the person is Mister or Mr.

MISS : Title of the person is Miss.

MADM : Title of the person is Madam. enum: - DOCT - MIST - MISS - MADM Number: maxLength: 18 type: number OrganisationIdentification4: type: object properties: BICOrBEI: pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: >- Code allocated to a financial institution or non financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)". Othr: type: array description: >- Unique identification of an organisation, as assigned by an institution, using an identification scheme. items: $ref: '#/components/schemas/GenericOrganisationIdentification1' description: Unique and unambiguous way to identify an organisation. IdentificationSchemeName1Choice: required: - Cd - Prtry type: object properties: Cd: maxLength: 4 minLength: 1 type: string description: >- Name of the identification scheme, in a coded form as published in an external list. Prtry: type: object description: Name of the identification scheme, in a free text form. allOf: - $ref: '#/components/schemas/Max35Text' PartyIdentification32: type: object properties: Nm: type: object description: >- Name by which a party is known and which is usually used to identify that party. allOf: - $ref: '#/components/schemas/Max140Text' PstlAdr: $ref: '#/components/schemas/PostalAddress6' Id: type: object properties: OrgId: $ref: '#/components/schemas/OrganisationIdentification4' PrvtId: $ref: '#/components/schemas/PersonIdentification5' description: >- Unique and unambiguous identification of a party. Should pass either OrgId or PrvtId for organisation and private respectively. CtryOfRes: type: object description: >- Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. allOf: - $ref: '#/components/schemas/CountryCode' CtctDtls: $ref: '#/components/schemas/ContactDetails2' PaymentIdentification1: required: - EndToEndId type: object properties: EndToEndId: type: object description: >- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. allOf: - $ref: '#/components/schemas/Max35Text' InstrId: type: object description: >- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. allOf: - $ref: '#/components/schemas/Max35Text' description: Set of elements used to reference a payment instruction. PaymentInstructionInformation3: required: - CdtTrfTxInf - Dbtr - DbtrAcct - DbtrAgt - PmtInfId - PmtMtd - ReqdExctnDt type: object properties: BtchBookg: type: boolean description: >- Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested. ChrgBr: $ref: '#/components/schemas/ChargeBearerType1Code' ChrgsAcct: type: object description: Account used to process charges associated with a transaction. allOf: - $ref: '#/components/schemas/CashAccount16' ChrgsAcctAgt: type: object description: Agent that services a charges account. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 CtrlSum: maxLength: 18 type: string description: >- Total of all individual amounts included in the group, irrespective of currencies. The number of fractional digits should not be more than 17. CdtTrfTxInf: minItems: 1 type: array description: >- Set of elements used to provide information on the individual transaction(s) included in the message. items: $ref: '#/components/schemas/CreditTransferTransactionInformation10' Dbtr: type: object description: Party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' DbtrAcct: type: object description: >- Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. allOf: - $ref: '#/components/schemas/CashAccount16' DbtrAgt: type: object description: Financial institution servicing an account for the debtor. allOf: - $ref: >- #/components/schemas/BranchAndFinancialInstitutionIdentification4 DbtrAgtAcct: type: object description: >- Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain. allOf: - $ref: '#/components/schemas/CashAccount16' NbOfTxs: pattern: '[0-9]{1,15}' type: string description: >- Number of individual transactions contained in the paymnet information group. PmtInfId: type: object description: >- Unique identification, as assigned by a sending party, to unambiguously identify the payment information group within the message. allOf: - $ref: '#/components/schemas/Max35Text' PmtMtd: type: string description: >- Specifies the means of payment that will be used to move the amount of money.

CHK : Written order to a bank to pay a certain amount of money from one person to another person.

TRF : Transfer of an amount of money in the books of the account servicer.

TRA : Transfer of an amount of money in the books of the account servicer. An advice should be sent back to the account owner. enum: - CHK - TRF - TRA PmtTpInf: $ref: '#/components/schemas/PaymentTypeInformation19' PoolgAdjstmntDt: type: object description: >- Date used for the correction of the value date of a cash pool movement that has been posted with a different value date. allOf: - $ref: '#/components/schemas/ISODate' ReqdExctnDt: type: object description: >- Date at which the initiating party requests the clearing agent to process the payment. allOf: - $ref: '#/components/schemas/ISODate' UltmtDbtr: type: object description: >- Ultimate party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' PaymentTypeInformation19: type: object properties: CtgyPurp: $ref: '#/components/schemas/CategoryPurpose1Choice' InstrPrty: $ref: '#/components/schemas/Priority2Code' LclInstrm: $ref: '#/components/schemas/LocalInstrument2Choice' SvcLvl: $ref: '#/components/schemas/ServiceLevel8Choice' description: Set of elements used to further specify the type of transaction. PersonIdentification5: type: object properties: DtAndPlcOfBirth: $ref: '#/components/schemas/DateAndPlaceOfBirth' Othr: type: array description: >- Unique identification of a person, as assigned by an institution, using an identification scheme. items: $ref: '#/components/schemas/GenericPersonIdentification1' description: >- Unique and unambiguous identification of a person, for example a passport. PostalAddress6: type: object properties: AdrLine: maxItems: 7 type: array description: >- Information that locates and identifies a specific address, as defined by postal services, presented in free format text. items: $ref: '#/components/schemas/Max70Text' AdrTp: type: string description: >- Identifies the nature of the postal address.

ADDR : Address is the complete postal address.

PBOX : Address is a postal office (PO) box.

HOME : Address is the home address.

BIZZ : Address is the business address.

MLTO : Address is the address to which mail is sent.

DLVY : Address is the address to which delivery is to take place. enum: - ADDR - PBOX - HOME - BIZZ - MLTO - DLVY BldgNb: type: object description: Number that identifies the position of a building on a street. allOf: - $ref: '#/components/schemas/Max16Text' Ctry: $ref: '#/components/schemas/CountryCode' CtrySubDvsn: type: object description: Identifies a subdivision of a country such as state, region, county. allOf: - $ref: '#/components/schemas/Max35Text' Dept: type: object description: Identification of a division of a large organisation or building. allOf: - $ref: '#/components/schemas/Max70Text' PstCd: type: object description: >- Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. allOf: - $ref: '#/components/schemas/Max16Text' StrtNm: type: object description: Name of a street or thoroughfare. allOf: - $ref: '#/components/schemas/Max70Text' SubDept: type: object description: >- Identification of a sub-division of a large organisation or building. allOf: - $ref: '#/components/schemas/Max70Text' TwnNm: type: object description: >- Name of a built-up area, with defined boundaries, and a local government. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Information that locates and identifies a specific address, as defined by postal services. ReferredDocumentInformation3: type: object properties: Nb: type: object description: Unique and unambiguous identification of the referred document. allOf: - $ref: '#/components/schemas/Max35Text' RltdDt: type: object description: Date associated with the referred document. allOf: - $ref: '#/components/schemas/ISODate' Tp: $ref: '#/components/schemas/ReferredDocumentType2' ReferredDocumentType1Choice: type: object properties: Cd: $ref: '#/components/schemas/DocumentType5Code' Prtry: type: object description: Proprietary identification of the type of the remittance document. allOf: - $ref: '#/components/schemas/Max35Text' description: >- Provides the type details of the referred document. Either Code or Proprietary field value should be passed on request. ReferredDocumentType2: required: - CdOrPrtry type: object properties: CdOrPrtry: $ref: '#/components/schemas/ReferredDocumentType1Choice' Issr: type: object description: Identification of the issuer of the reference document type. allOf: - $ref: '#/components/schemas/Max35Text' description: Specifies the type of referred document. RegulatoryReporting3: type: object properties: Authrty: type: object properties: Ctry: type: object description: >- Country of the entity that requires the regulatory reporting information. allOf: - $ref: '#/components/schemas/CountryCode' Nm: type: object description: >- Name of the entity requiring the regulatory reporting information. allOf: - $ref: '#/components/schemas/Max140Text' description: Entity requiring the regulatory reporting information. DbtCdtRptgInd: type: string description: >- Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

CRED : Regulatory information applies to the credit side.

DEBT : Regulatory information applies to the debit side.

BOTH : Regulatory information applies to both credit and debit sides. enum: - CRED - DEBT - BOTH Dtls: type: array description: >- Set of elements used to provide details on the regulatory reporting information. items: $ref: '#/components/schemas/StructuredRegulatoryReporting3' RemittanceAmount1: type: object properties: AdjstmntAmtAndRsn: type: array description: >- Set of elements used to provide information on the amount and reason of the document adjustment. items: $ref: '#/components/schemas/DocumentAdjustment1' CdtNoteAmt: type: object description: >- Amount specified for the referred document is the amount of a credit note. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' DscntApldAmt: type: object description: >- Amount of money that results from the application of an agreed discount to the amount due and payable to the creditor. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' DuePyblAmt: type: object description: >- Amount specified is the exact amount due and payable to the creditor. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' RmtdAmt: type: object description: Amount of money remitted for the referred document. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TaxAmt: type: object description: Quantity of cash resulting from the calculation of the tax. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: >- Set of elements used to provide details on the amounts of the referred document. RemittanceInformation5: type: object properties: Strd: type: array description: >- Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form. items: $ref: '#/components/schemas/StructuredRemittanceInformation7' Ustrd: type: array description: >- Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. items: $ref: '#/components/schemas/Max140Text' RemittanceLocation2: type: object properties: RmtId: type: object description: >- Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice. allOf: - $ref: '#/components/schemas/Max35Text' RmtLctnElctrncAdr: type: object description: >- Electronic address to which an agent is to send the remittance information. allOf: - $ref: '#/components/schemas/Max2048Text' RmtLctnMtd: type: string description: >- Method used to deliver the remittance advice information.

FAXI : Remittance advice information must be faxed.

EDIC : Remittance advice information must be sent through Electronic Data Interchange (EDI).

URID : Remittance advice information needs to be sent to a Uniform Resource Identifier (URI). URI is a compact string of characters that uniquely identify an abstract or physical resource. URI's are the super-set of identifiers, such as URLs, email addresses, ftp sites, etc, and as such, provide the syntax for all of the identification schemes.

EMAL : Remittance advice information must be sent through e-mail.

POST : Remittance advice information must be sent through postal services.

SMSM : Remittance advice information must be sent through by phone as a short message service (SMS). enum: - FAXI - EDIC - URID - EMAL - POST - SMSM RmtLctnPstlAdr: type: object description: >- Postal address to which an agent is to send the remittance information. allOf: - $ref: '#/components/schemas/NameAndAddress10' StructuredRegulatoryReporting3: type: object properties: Amt: type: object description: >- Amount of money to be reported for regulatory and statutory requirements. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Cd: type: object description: >- Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form. allOf: - $ref: '#/components/schemas/Max10Text' Ctry: type: object description: >- Country related to the specified type of regulatory reporting details. allOf: - $ref: '#/components/schemas/CountryCode' Dt: type: object description: Date related to the specified type of regulatory reporting details. allOf: - $ref: '#/components/schemas/ISODate' Inf: type: array description: >- Additional details that cater for specific domestic regulatory requirements. items: $ref: '#/components/schemas/Max35Text' Tp: type: object description: >- Specifies the type of the information supplied in the regulatory reporting details. allOf: - $ref: '#/components/schemas/Max35Text' StructuredRemittanceInformation7: type: object properties: AddtlRmtInf: maxItems: 3 type: array description: >- Additional information, in free text form, to complement the structured remittance information. items: $ref: '#/components/schemas/Max140Text' CdtrRefInf: $ref: '#/components/schemas/CreditorReferenceInformation2' Invcee: type: object description: >- Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor. allOf: - $ref: '#/components/schemas/PartyIdentification32' Invcr: type: object description: >- Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor. allOf: - $ref: '#/components/schemas/PartyIdentification32' RfrdDocAmt: $ref: '#/components/schemas/RemittanceAmount1' RfrdDocInf: type: array description: >- Set of elements used to identify the documents referred to in the remittance information. items: $ref: '#/components/schemas/ReferredDocumentInformation3' TaxAmount1: type: object properties: Dtls: type: array description: >- Set of elements used to provide details on the tax period and amount. items: $ref: '#/components/schemas/TaxRecordDetails1' Rate: maxLength: 11 type: string description: Rate used to calculate the tax. TaxblBaseAmt: type: object description: Amount of money on which the tax is based. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TtlAmt: type: object description: >- Total amount that is the result of the calculation of the tax for the record. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: >- Set of elements used to provide information on the amount of the tax record. TaxInformation3: type: object properties: AdmstnZn: type: object description: Territorial part of a country to which the tax payment is related. allOf: - $ref: '#/components/schemas/Max35Text' Cdtr: $ref: '#/components/schemas/TaxParty1' Dt: type: object description: Date by which tax is due. allOf: - $ref: '#/components/schemas/ISODate' Dbtr: $ref: '#/components/schemas/TaxParty2' Mtd: type: object description: >- Method used to indicate the underlying business or how the tax is paid. allOf: - $ref: '#/components/schemas/Max35Text' Rcrd: type: array description: Record of tax details. items: $ref: '#/components/schemas/TaxRecord1' RefNb: type: object description: Tax reference information that is specific to a taxing agency. allOf: - $ref: '#/components/schemas/Max140Text' SeqNb: type: object description: Sequential number of the tax report. allOf: - $ref: '#/components/schemas/Number' TtlTaxAmt: type: object description: Total amount of money as result of the calculation of the tax. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TtlTaxblBaseAmt: type: object description: Total amount of money on which the tax is based. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' description: Set of elements used to provide details on the tax. TaxPeriod1: type: object properties: FrToDt: type: object description: >- Range of time between a start date and an end date for which the tax report is provided. allOf: - $ref: '#/components/schemas/DatePeriodDetails' Tp: $ref: '#/components/schemas/TaxRecordPeriod1Code' Yr: type: object description: Year related to the tax payment. allOf: - $ref: '#/components/schemas/ISODate' description: >- Set of elements used to provide details on the period of time related to the tax payment. TaxRecord1: type: object properties: AddtlInf: type: object description: Further details of the tax record. allOf: - $ref: '#/components/schemas/Max140Text' Ctgy: type: object description: Specifies the tax code as published by the tax authority. allOf: - $ref: '#/components/schemas/Max35Text' CtgyDtls: type: object description: Provides further details of the category tax code. allOf: - $ref: '#/components/schemas/Max35Text' CertId: type: object description: >- Identification number of the tax report as assigned by the taxing authority. allOf: - $ref: '#/components/schemas/Max35Text' DbtrSts: type: object description: >- Code provided by local authority to identify the status of the party that has drawn up the settlement document. allOf: - $ref: '#/components/schemas/Max35Text' FrmsCd: type: object description: >- Identifies, in a coded form, on which template the tax report is to be provided. allOf: - $ref: '#/components/schemas/Max35Text' Prd: $ref: '#/components/schemas/TaxPeriod1' TaxAmt: $ref: '#/components/schemas/TaxAmount1' Tp: type: object description: High level code to identify the type of tax details. allOf: - $ref: '#/components/schemas/Max35Text' TaxRecordDetails1: required: - Amt type: object properties: Amt: type: object description: Underlying tax amount related to the specified period. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' Prd: $ref: '#/components/schemas/TaxPeriod1' disclosure_request: type: object properties: in: required: - bankCode - bankCodeType - chargeCode - clientId - destinationCountry - estimatePercentile - flagFutureDated - flagODE - fundingCurrency - isBeneDeduct - nonSTPFlag - paymentCurrency - paymentCurrencyAmount - paymentMethod - releaseTime - valueDate - subEntityId - beneDeductFeeType - nostroCountry type: object properties: clientId: maxLength: 5 type: string description: WorldLink specific client number if using WorldLink routing. subEntityId: maxLength: 4 type: string description: WorldLink Branch (Sub entity number). destinationCountry: maxLength: 2 type: string description: >- Value any country through or to which CITI transfers money via Fed Wire or ACH. destinationState: maxLength: 35 type: string description: >- Destination State. If the full state or province is available it may be passed here. If this is in the database it will return the value, otherwise it will default. This entry is for tax calculation only. destinationCity: maxLength: 35 type: string description: >- Destination City. If the full City is available it may be passed here. If this is in the database it will return the value, otherwise it will default. This entry is for tax calculation only. bankCode: maxLength: 20 type: string description: >- ID of bank through which money can be sent. This is used in conjunction with Bank Code Type. bankCodeType: maxLength: 1 type: string description: This is used in conjunction with Bank Code B-BIC. paymentMethod: maxLength: 1 type: string description: As a default pass 'W'ire W (wire), A (ACH), C (Cash) paymentCurrency: maxLength: 3 type: string description: Payment currency SWIFT(ISO) code. fundingCurrency: maxLength: 3 type: string description: Funding currency SWIFT(ISO) code. paymentCurrencyAmount: type: number description: >- Decimals dependent on currency number 19,3 .Between 0.00 and 9999999999999999.999 nonSTPFlag: maxLength: 1 type: string description: >- This will always default to ‘N’ for straight through processing. Always pass ‘N’. citiPointOfOrigination: maxLength: 2 type: string description: >- Location of Nostro account or US. Allowable Value(2 characters) or space. Not allowed unless bank code is present. This tag may be used if the client is not routing through the WorldLink Omnibus accounts. Use of this value is to be coordinated with the DF Table administrator. isBeneDeduct: maxLength: 1 type: string description: >- Accesses Bene Deduct table if Yes [Y]. Client should pass 'Y' if they know bene deduct fees are being applied. enum: - 'Y' - 'N' beneDeductFeeType: maxLength: 1 type: string description: >- Flat(F) or Tiered(T). Value must be present if Bene Deduct indicator is Y. Spaces or no tag transmitted if Bene Deduct is N. enum: - F - T estimatePercentile: type: integer description: >- Estimate Percentile (80, 90 or 95) (required in case fee found is estimated, the API will return the appropriate value) chargeCode: maxLength: 3 type: string description: | BEN -- fees charged to beneficiaries SHA -- fees shared OUR -- Fees by bank/RTP releaseTime: type: string description: >- Time that transactions will be released after the designated hold period. Format: yyyy-mm-ddThh:mm:ss. nostroCountry: type: string description: Valid two digit country code. flagODE: type: string description: >- Our Deduct Flag. Both isBeneDeduct and flagODE, can't be Y, at the same time. When flagODE is Y, ChargeCode can't be anything other than OUR enum: - 'Y' - 'N' valueDate: type: string description: Value date for the payment. format: date flagFutureDated: maxLength: 1 type: string description: Indicates whether it is future dated transaction. enum: - 'Y' - 'N' example: clientId: '24884' subEntityId: '0001' destinationCountry: IN destinationState: AK destinationCity: ANCHORAGE bankCode: CITIIN00 bankCodeType: B paymentMethod: W paymentCurrency: INR fundingCurrency: USD paymentCurrencyAmount: 100 nonSTPFlag: 'N' isBeneDeduct: 'Y' citiPointOfOrigination: US estimatePercentile: 95 chargeCode: OPT releaseTime: '2019-11-28T16:11:23.000' nostroCountry: AU valueDate: '2019-11-28' flagFutureDated: 'N' flagODE: 'Y' beneDeductFeeType: F disclosure_response: type: object properties: out: required: - deliveryDate - disclosureDate - feeType - otherFees - returnCode - returnMessage - totalTaxes - uniqueIdentifier type: object properties: disclosureDate: type: string description: >- The disclosure date. Format => Timestamp > yyyy-mm-dd hh:mm:ss[.fffffffff]. otherFees: type: number description: >- Sum of all fees calculated, including bene deduct. Between 0.00 and 9999999999999999.999 feeType: maxLength: 1 type: string description: Fee description Actual(A) or Estimate(E). enum: - A - E totalTaxes: type: number description: >- Sum of all taxes calculated. Between 0.00 and 9999999999999999.999. deliveryDate: type: string description: >- The calculated delivery date for payment. Format => Timestamp > yyyy-mm-dd hh:mm:ss[.fffffffff]. uniqueIdentifier: maxLength: 15 type: string description: API Packet identifier. returnCode: maxLength: 5 type: string description: Code to show if API worked. returnMessage: maxLength: 100 type: string description: >- Descriptive message to show if API passed, or the reason for the failure. chargeCodeUsed: maxLength: 3 type: string description: >- Charge code calculated by Dodd-Frank application based on its rules. beneDeductUsed: maxLength: 1 type: string description: >- Bene deduct fee indicator passed in input request field isBeneDeduct. beneDeductFeeTypeUsed: maxLength: 1 type: string description: >- Bene deduct fee type passed in input request field beneDeductFeeType. example: disclosureDate: '2019-25-04T08:13:21.123-05:00' otherFees: 25 feeType: E totalTaxes: 2 deliveryDate: '2019-25-04T08:13:21.123-05:00' uniqueIdentifier: '000000000810814' returnCode: '0' returnMessage: SUCCESS chargeCodeUsed: BEN PaymentInquiryRequest: required: - EndToEndId - WLClientID type: object properties: EndToEndId: maxLength: 35 pattern: '[a-zA-Z0-9_]*' type: string description: >- Unique identification assigned by the initiating party to clearly identify the transaction. This Identification is passed on, unchanged, throughout the entire end-to-end chain. example: API_2WAY_WIRE_01 WLClientID: maxLength: 35 pattern: '[a-zA-Z0-9]*' type: string description: >- Client ID to uniquely identify the transaction along with transaction reference number. example: '000000001' WLRef: maxLength: 12 pattern: '[a-zA-Z0-9]*' type: string description: >- WorldLink generated unique reference number received in WorldLink Payment Initiation response example: KH80FI20GBY4 CreDtTm: type: string description: >- Date when the payment initiation started. The date format is YYYY-MM-DD. format: date example: '2020-09-12' ReqdExctnDt: type: string description: >- The date that the initiating party requests that the clearing agent process the payment. format: date example: '2017-09-05' InstdAmt: type: object description: >- This represents the amount of money transferred between the debtor and the creditor before any deduction of charges is made. This is expressed in the currency that is specified by the initiating party. allOf: - $ref: >- #/components/schemas/ActiveOrHistoricCurrencyAndAmountStatusInquiry EqvtAmt: required: - Amt - CcyOfTrf type: object properties: Amt: type: object description: Amount of money allOf: - $ref: >- #/components/schemas/ActiveOrHistoricCurrencyAndAmountStatusInquiry CcyOfTrf: type: object description: >- Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' description: >- Partner can send either Payment Amount or Equivalent Amount and not both description: Payment Status Inquiries Inputs paymentStatusInquiryResponse: type: string description: >- Base64 encoded string of ISO XML the response follows ISOXML urn:iso:std:iso:20022:tech:xsd:pain.002.001.03 https://www.iso20022.org/message/14361/download or #/definitions/Pain002 format: byte example: >- PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxEb2N1bWVudCB4bWxucz0idXJuOmlzbzpzdGQ6aXNvOjIwMDIyOnRlY2g6eHNkOnBhaW4uMDAyLjAwMS4wMyI+DQoJPENzdG1yUG10U3RzUnB0Pg0KCQk8R3JwSGRyPg0KCQkJPE1zZ0lkPkNJVElCQU5LLzIwMTkxMjExLVBTUi85NDE0MTYxNzc8L01zZ0lkPg0KCQkJPENyZUR0VG0+MjAxOS0xMi0xMVQwNjoyNDo1MjwvQ3JlRHRUbT4NCgkJCTxJbml0Z1B0eT4NCgkJCQk8SWQ+DQoJCQkJCTxPcmdJZD48QklDT3JCRUk+Q0lUSVVTMzM8L0JJQ09yQkVJPjwvT3JnSWQ+DQoJCQkJPC9JZD4NCgkJCTwvSW5pdGdQdHk+DQoJCTwvR3JwSGRyPg0KCQk8T3JnbmxHcnBJbmZBbmRTdHM+DQoJCQk8T3JnbmxNc2dJZD5Nc2dJZGZmZ2g8L09yZ25sTXNnSWQ+DQoJCQk8T3JnbmxNc2dObUlkPnBhaW4uMDA3LjAwMS4wOTwvT3JnbmxNc2dObUlkPg0KCQkJPE9yZ25sQ3JlRHRUbT4yMDE5LTEyLTExVDEyOjAwOjAwPC9PcmdubENyZUR0VG0+DQoJCQk8T3JnbmxOYk9mVHhzPjE8L09yZ25sTmJPZlR4cz4NCgkJPC9PcmdubEdycEluZkFuZFN0cz4NCgkJPE9yZ25sUG10SW5mQW5kU3RzPg0KCQkJPE9yZ25sUG10SW5mSWQ+NDU2ODc5NjwvT3JnbmxQbXRJbmZJZD4NCgkJCTxUeEluZkFuZFN0cz4NCgkJCQk8T3JnbmxFbmRUb0VuZElkPjIwMTkxMjA5Q0lUSVNHUzBCUlQyMTAxNjMwPC9PcmdubEVuZFRvRW5kSWQ+DQoJCQkJPFR4U3RzPkFDVEM8L1R4U3RzPg0KCQkJPC9UeEluZkFuZFN0cz4NCgkJPC9PcmdubFBtdEluZkFuZFN0cz4NCgk8L0NzdG1yUG10U3RzUnB0Pg0KPC9Eb2N1bWVudD4= xml: name: paymentStatusInquiryResponse ActiveOrHistoricCurrencyAndAmountStatusInquiry: required: - Amt - Ccy type: object properties: Ccy: type: object description: Currency code. allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' Amt: $ref: >- #/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleTypeStatusInquiry ActiveOrHistoricCurrencyAndAmount_SimpleTypeStatusInquiry: type: string description: Upto 3 fraction digits allowed examples: Payment-Status-Inquiry-Response-Json: value: FxGetDealOperationResponse: FXP588INOperationResponse: FxDealInquiryRsp: Source: APIM WLClntId: '629550001' ContractRef: M16463100879607 UserId: XBACBC4 ResTime: 2026-04-07-07:39:20 PymtCcy: CAD PymtCcyAmt: '145.00' FundCcy: EUR FundCcyAmt: '90.04' Symbol: CADEUR Rate: '0.62100000' BookDate: '20251024' ValueDate: '20251027' DealTs: 2025-10-24-04.02.26.701438 FundActTotalLmt: '90.04' FundActAvlLmt: '90.04' FundActEarMrkLmt: '0.00' FundActUtilLmt: '0.00' PymtActTotalLmt: '145.00' PymtActAvlLmt: '145.00' PymtActEarMrkLmt: '0.00' PymtActUtilLmt: '0.00' StatusCode: '000' StatusMsg: '000: Requested deal found' Payment-Validation-Request-Json: value: '@xmlns': urn:iso:std:iso:20022:tech:xsd:pain.001.001.03 customer_credit_transfer_initiation: group_header: message_identification: Wire_SZD_API_1401 creation_date_time: '2020-02-20T09:30:47' number_of_transactions: '1' control_sum: '200' initiating_party: name: MSA ILE DE FRANCE postal_address: address_type: ADDR department: Dept001 sub_department: Subdept001 street_name: street name01 building_number: '113232370123456' post_code: '7777777' town_name: townname1townname1townna country_sub_division: subdivctry01 country: GB identification: organisation_identification: other: - identification: '248840001' country_of_residence: TR contact_details: name: Client5 payment_information: - payment_information_identification: Wire_SZD_FD_API_1401 payment_method: TRF requested_execution_date: '2020-07-22' debtor: name: MSA ILE DE FRANCE postal_address: address_type: ADDR department: Dept001 street_name: street name01 building_number: '113232370123456' post_code: '7777777' town_name: townname1 country_sub_division: subdivctry01 country: SZ debtor_account: identification: other: identification: '789652' currency: CAD debtor_agent: financial_institution_identification: bic: CITICA5AXXX other: identification: '248840001' credit_transfer_transaction_information: - payment_identification: instruction_identification: JA2020072233 end_to_end_identification: JA2020072233 payment_type_information: service_level: code: URGP category_purpose: code: OTHR amount: instructed_amount: currency: EUR $: '200' charge_bearer: SHAR creditor_agent: financial_institution_identification: bic: SOGEADPPXXX name: Bene Bank Name postal_address: street_name: Wellsprings Renaissanc building_number: Building No 02 post_code: '71492' town_name: Newtownships country: AD creditor: name: Rehan postal_address: address_type: HOME street_name: Mumbai building_number: '113232123456' country: AD creditor_account: identification: iban: AD1200012030200359100100 remittance_information: unstructured: - '12796190145799300' Payment-Validation-Response-Json: value: '@xmlns': urn:iso:std:iso:20022:tech:xsd:pain.002.001.03 customer_payment_status_report: group_header: message_identification: Wire_SZD_API_1401 creation_date_time: '2020-02-20T09:30:47' initiating_party: name: MSA ILE DE FRANCE postal_address: address_type: ADDR department: Dept001 sub_department: Subdept001 street_name: street name01 building_number: '113232370123456' post_code: '7777777' town_name: townname1townname1townna country_sub_division: subdivctry01 country: GB identification: organisation_identification: other: - identification: '248840001' country_of_residence: TR contact_details: name: Client5 original_group_information_and_status: original_message_identification: Wire_SZD_API_1401 original_message_name_identification: Pain.001.001.03 original_creation_date_time: '2020-02-20T09:30:47' original_number_of_transactions: '1' original_control_sum: '200' original_payment_information_and_status: - original_payment_information_identification: Wire_SZD_FD_API_1401 transaction_information_and_status: - original_instruction_identification: JA2020072235 original_end_to_end_identification: JA2020072235 transaction_status: RJCT status_reason_information: - additional_information: - Target Account Number IBAN: Field'Target_Account_Number_IBAN' is mandatory. original_transaction_reference: amount: instructed_amount: currency: EUR $: '200' requested_execution_date: '2020-07-22' payment_type_information: service_level: code: URGP category_purpose: code: OTHR payment_method: TRF remittance_information: unstructured: - '12796190145799300' debtor: name: MSA ILE DE FRANCE postal_address: address_type: ADDR department: Dept001 street_name: street name01 building_number: '113232370123456' post_code: '7777777' town_name: townname1 country_sub_division: subdivctry01 country: SZ debtor_account: identification: other: identification: '789652' currency: CAD debtor_agent: financial_institution_identification: bic: CITICA5AXXX other: identification: '248840001' creditor_agent: financial_institution_identification: bic: SOGEADPPXXX name: Bene Bank Name postal_address: street_name: Wellsprings Renaissanc building_number: Building No 02 post_code: '71492' town_name: Newtownships country: AD creditor: name: Rehan postal_address: address_type: HOME street_name: Mumbai building_number: '113232123456' country: AD creditor_account: identification: other: identification: '14258632545' securitySchemes: clientCredentials: description: >+ All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token. type: oauth2 flows: clientCredentials: tokenUrl: /authenticationservices/v3/oauth/token scopes: {}