Supporting info full JSON schema
Here is the full listing of the supporting information object expressed as a JSON Schema.
Click to expand
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "file://po11#",
"title": "RippleNet Payment Object - Supporting Information Schema",
"description": "RippleNet Payment Object - Supporting Information Schema, Version 1.1.5",
"definitions": {
"externalclearingsystem": {
"type": "string",
"description": "List based on ISO20022 ExternalClearingSystemIdentification1Code List",
"enum": [
"ATBLZ",
"AUBSB",
"BEFTN",
"CACPA",
"CHBCC",
"CHSIC",
"CNAPS",
"DEBLZ",
"ESNCC",
"GBDSC",
"GRBIC",
"HKNCC",
"IENCC",
"INFSC",
"ITNCC",
"JPZGN",
"NGBCS",
"NZNCC",
"PLKNR",
"PTNCC",
"RUCBC",
"SESBA",
"SGIBG",
"SLCFT",
"THCBC",
"TWNCC",
"USABA",
"USPID",
"ZANCC"
]
},
"externalcashaccount": {
"type": "string",
"description": "List based on ISO20022 ExternalCashAccountType1Code List",
"enum": [
"CACC",
"CARD",
"CASH",
"CHAR",
"CISH",
"COMM",
"CPAC",
"LLSV",
"LOAN",
"MGLD",
"MOMA",
"NREX",
"ODFT",
"ONDP",
"OTHR",
"SACC",
"SLRY",
"SVGS",
"TAXE",
"TRAN",
"TRAS"
]
},
"levelofpurpose": {
"type": "string",
"description": "List based on ISO20022 ExternalCategoryPurpose1Code List",
"enum": [
"BONU",
"CASH",
"CBLK",
"CCRD",
"CORT",
"DCRD",
"DIVI",
"DVPM",
"EPAY",
"FCIN",
"FCOL",
"GOVT",
"GP2P",
"HEDG",
"ICCP",
"IDCP",
"INTC",
"INTE",
"LBOX",
"LOAN",
"MP2B",
"MP2P",
"OTHR",
"PENS",
"RPRE",
"RRCT",
"RVPM",
"SALA",
"SECU",
"SSBE",
"SUPP",
"TAXS",
"TRAD",
"TREA",
"VATX",
"WHLD"
]
},
"SourceOfCash": {
"type": "string",
"description": "Source where funds have come from for the payment.",
"enum": [
"ALMY",
"CASH",
"COMP",
"EMIN",
"GIFT",
"INHE",
"INLQ",
"PACA",
"REDM",
"REPY",
"REST",
"RETA",
"SALE",
"SEAQ",
"SELF",
"SVGS",
"WINS"
]
},
"external_account_id": {
"type": "string",
"description": "Identifier of an account, as assigned by the account servicer, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists ",
"enum": [
"AIIN",
"BBAN",
"CARD",
"CASH",
"CASHD2D",
"CUID",
"UPIC",
"EMail",
"MSISDN",
"Dmst",
"Other"
]
},
"bic": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list."
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
},
"phone_number": {
"type": "string",
"description": "Code allocated to identify a contact phone number."
},
"iban": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){15,35}$",
"description": "IBAN for the account."
},
"fullname": {
"description": "Name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 140
},
"name": {
"type": "object",
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 20
}
}
},
"address": {
"type": "object",
"properties": {
"AdrTp": {
"type": "string",
"description": "List based on ISO20022 AddressType1Code List",
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
]
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"$ref": "#/definitions/country"
}
}
},
"id_section": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"description": "Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identiFer code (BIC)'",
"$ref": "#/definitions/bic"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date-time"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}$"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIss": {
"description": "Information that identifies the date of incorporation in ISO Date format (YYYY-MM-DD) for a sending organization or institution.",
"type": "string",
"maxLength": 10
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date-time"
},
"DtOfXpry": {
"description": "The date of expiration of the supporting documentation.",
"type": "string",
"format": "date-time"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
]
},
"RelShipToCdtr": {
"type": "string",
"description": "Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
]
},
"Rprtv": {
"type": "object",
"description": "Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "Allows the name of the organization's representative to be held in a structured format.",
"$ref": "#/definitions/name"
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth in ISO Date format (YYYY-MM-DD) for the party.",
"type": "string",
"format": "date-time"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"$ref": "#/definitions/country"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "Date of Issue for Passport",
"format": "date-time"
},
"DtOfExpr": {
"type": "string",
"description": "Date of Expiry for Passport",
"format": "date-time"
},
"MrzNb": {
"description": "Machine Readable Zone for Passport",
"type": "string",
"maxLength": 88,
"pattern": "/([A-Z])([A-Z0-9<])([A-Z]{3})([A-Z<]{39})\n([A-Z0-9<]{9})([0-9])([A-Z]{3})([0-9]{6})([0-9])([MF<])([0-9]{6})([0-9])([A-Z0-9<]{14})([0-9])([0-9])/im"
}
}
},
"Gender":{
"description": "Information that captures the ender of a party. Supported values: Male, Female, Other.",
"type": "string",
"maxLength": 6
},
"Profession": {
"description": "Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "Relationship of the receiving party to the sending party.",
"type": "string",
"enum":[
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
]
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country of nationality of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Citizenship": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor. Provide a value of Yes or No.",
"type": "string",
"maxLength": 3
},
"StartDt": {
"description": "Start date of citizenship in ISO Date format (YYYY-MM-DD) for the party.",
"type": "string",
"format": "date-time"
},
"EndDt": {
"description": "End date of citizenship in ISO Date format (YYYY-MM-DD) for the party.",
"type": "string",
"format": "date-time"
}
}
}
}
}
}
},
"contact_details": {
"type": "object",
"description": "Contact Details for the individual or organization",
"properties": {
"CtctDtls": {
"type": "object",
"description": "Set of elements used to indicate how to contact the party.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
]
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"$ref": "#/definitions/phone_number"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"$ref": "#/definitions/phone_number"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"$ref": "#/definitions/phone_number"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"account_name": {
"description": "Name by which the account is known and which is usually used to identify the account.",
"type": "string",
"maxLength": 140
},
"account_id": {
"type": "object",
"description": "Specifies the unique identification of an account as assigned by the account servicer.",
"properties": {
"IBAN": {
"$ref": "#/definitions/iban"
},
"Othr": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 34
},
"SchmeNm": {
"type": "object",
"description": "Name of the account identification scheme.",
"properties": {
"Cd": {
"$ref": "#/definitions/external_account_id"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"account_type": {
"type": "object",
"description": "Nature or use of the account.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalCashAccountType1Code List",
"$ref": "#/definitions/externalcashaccount"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"financial_institution": {
"type": "object",
"description": "Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.",
"properties": {
"BICFI": {
"$ref": "#/definitions/bic"
},
"Nm": {
"$ref": "#/definitions/fullname"
},
"ClrSysMmbId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"properties": {
"MmbId": {
"description": "Contains the routing code / sort code for the institution",
"type": "string",
"maxLength": 35
},
"ClrSysId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"properties": {
"Cd": {
"$ref": "#/definitions/externalclearingsystem"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Othr": {
"type": "object",
"description": "Unique identification of an agent, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a person."
},
"SchmeNm": {
"type": "object",
"description": "Name of the agent identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Based on list for externalfinancialinstitution1code defined by ISO 20022"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"branch_id": {
"type": "object",
"description": "Identifies a specific branch of a financial institution.",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a branch of a financial institution.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name for the Branch",
"$ref": "#/definitions/fullname"
},
"PstlAdr": {
"type": "object",
"description": "Address for the Branch",
"$ref": "#/definitions/address"
}
}
}
},
"type": "object",
"properties": {
"required": [
"version",
"accepting_client_id",
"connector_role",
"locking_client_id"
],
"version": {
"type": "string",
"description": "Defines which version of the Payment Object Supporting Information is used",
"maxLength": 10
},
"receiver_version": {
"description": "Specification for the RPO version provided by the Receiving Member.",
"type": "string",
"maxLength": 20
},
"locking_client_id": {
"description": "This is a system populated field.",
"type": "string"
},
"connector_role": {
"description": "This is a system populated field.",
"type": "string"
},
"return_payment": {
"type": "string",
"description": "The payment_id of the original payment specified in the request."
},
"return_reasons": {
"type": "array",
"description": "Fields that describe the reason for the return and other metadata related to the return. These are the same fields specified in the request.",
"items": [
{
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of return, as defined in the RippleNet Rulebook."
},
"code": {
"type": "string",
"description": "ISO 20022 code for the return, as defined in the RippleNet Rulebook."
},
"reason": {
"type": "string",
"description": "ISO 20022 reason for the return, as defined in the RippleNet Rulebook."
}
}
}
]
}
]
},
"accepting_client_id": {
"description": "This is a system populated field.",
"type": "string"
},
"external_id": {
"description": "This is a sender or receiver populated field, used for their internal usage purposes.",
"type": "string"
},
"SourceOfCash": {
"$ref": "#/definitions/SourceOfCash"
},
"PmtId": {
"type": "object",
"description": "Set of elements used to reference a payment instruction.",
"properties": {
"InstrId": {
"description": "Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.",
"type": "string",
"maxLength": 35
},
"TxId": {
"type": "string",
"description": "Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.",
"maxLength": 35
},
"ClrSysRef": {
"type": "string",
"description": "Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.",
"maxLength": 35
},
"Uetr": {
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
"description": "Unique End-to-end Transaction Reference, generated by the Payer and passed through, without modification by the payment participants through to the beneficiary.",
"maxLength": 36
}
}
},
"PmtTpInf": {
"type": "object",
"description": "Set of elements used to further specify the type of transaction.",
"properties": {
"InstrPrty": {
"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. List based on ISO20022 Priority2Code List",
"enum": [
"HIGH",
"NORM"
]
},
"ClrChanl": {
"type": "string",
"description": "List based on ISO20022 ClearingChannel2Code List",
"enum": [
"RTGS",
"RTNS",
"MPNS",
"BOOK"
]
},
"CtgyPurp": {
"type": "object",
"description": "Specifies the high level purpose of the instruction based on a set of pre-defined categories.",
"properties": {
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
},
"Cd": {
"$ref": "#/definitions/levelofpurpose"
}
}
},
"SvcLvl": {
"type": "object",
"description": "Agreement under which or rules under which the transaction should be processed.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 List ExternalServiceLevel1Code",
"enum": [
"BKTR",
"NPCA",
"NUGP",
"NURG",
"PRPT",
"SDVA",
"SEPA",
"SVDE",
"URGP",
"URNS",
"G001",
"G002",
"G003",
"G004"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"LclInstrm": {
"type": "object",
"description": "User community specific instrument.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 List ExternalLocalInstrument1Code",
"enum": [
"DDMC",
"DDMP",
"DDMU",
"TRF",
"82",
"83",
"CPP",
"RTR",
"GST",
"DDT",
"RDD",
"CHN",
"STR",
"SDD",
"SRT",
"SRD",
"SCN",
"SGT",
"CARD",
"05",
"04",
"ISE",
"BSE",
"IN",
"58",
"19",
"85",
"08",
"89",
"60",
"RIBA",
"RIDO",
"RIDV",
"IDEAL",
"INSTNT01",
"INSTTC01",
"INSTIDEAL",
"INSTNT01IDEAL",
"INSTTC01IDEAL",
"NLDO",
"NLUP",
"ACCEPT",
"SDN",
"NLGOV",
"0090",
"0091",
"0092",
"0002",
"0221",
"0224",
"0226",
"0225",
"0222",
"0227",
"0220",
"0223",
"0001",
"0000",
"ONCL",
"SDCL",
"DDNR",
"DDFA",
"CORE",
"B2BAMIPM",
"B2B",
"CR1AMIPM",
"CORAMIPM",
"COR1",
"FADAMIPM",
"CLSCCPERX",
"CLSCCPLCH",
"INST",
"ADD",
"UDD",
"CCI",
"BTR",
"CKS",
"CTR",
"CTP",
"DEP",
"FFR",
"FFS",
"SVC",
"DRW",
"DRB",
"DRC",
"IAT",
"CCD",
"CTX",
"PPD",
"CIE",
"RCK",
"ARC",
"WEB",
"POP",
"POS",
"TEL",
"BPA",
"IPA",
"ASTI",
"BACP",
"MANP",
"SBTI",
"ICMC",
"PERI"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"ChrgBr": {
"description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction. Use ISO ChargeBearerType1Code list, supported values are CRED, DEBT & SHAR.",
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR"
]
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Ultimate Debtor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Ultimate Debtor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Ultimate Debtor to be held.",
"$ref": "#/definitions/address"
},
"CtctDtls": {
"type": "object",
"description": "Allows the Country of Residence of the Ultimate Debtor to be held.",
"$ref": "#/definitions/contact_details"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Ultimate Debtor.",
"$ref": "#/definitions/id_section"
}
}
},
"InitgPty": {
"type": "object",
"description": "Party that initiates the payment.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Initiating Party to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Initiating Party to be held.",
"$ref": "#/definitions/address"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Initiating Party.",
"$ref": "#/definitions/id_section"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Initiating Party to be held.",
"$ref": "#/definitions/country"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Initiating Party to be held.",
"$ref": "#/definitions/contact_details"
}
}
},
"Dbtr": {
"type": "object",
"description": "Party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Debtor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Debtor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Debtor to be held.",
"$ref": "#/definitions/country"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Debtor to be held.",
"$ref": "#/definitions/address"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Debtor.",
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Debtor to be held.",
"$ref": "#/definitions/contact_details"
}
}
},
"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.",
"properties": {
"Nm": {
"type": "string",
"description": "Name by which the account is known and which is usually used to identify the Debtor account.",
"$ref": "#/definitions/account_name"
},
"Ccy": {
"type": "string",
"description": "Currency for the Debtor Account",
"$ref": "#/definitions/currency"
},
"Id": {
"type": "object",
"description": "Nature or use of the Debtor account.",
"$ref": "#/definitions/account_id"
},
"Tp": {
"type": "object",
"description": "Nature or use of the Debtor account.",
"$ref": "#/definitions/account_type"
}
}
},
"DbtrAgt": {
"type": "object",
"description": "Financial institution servicing an account for the debtor.",
"properties": {
"FinInstnId": {
"type": "object",
"description": "Allows the details of the Debtor Agent to be held",
"$ref": "#/definitions/financial_institution"
},
"BrnchId": {
"type": "object",
"description": "Allows the details of the Debtor Agent Branch to be held",
"$ref": "#/definitions/branch_id"
}
}
},
"DbtrAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.",
"properties": {
"Id": {
"type": "object",
"description": "Unique and unambiguous identification for the account between the account owner and the account servicer.",
"$ref": "#/definitions/account_id"
},
"Tp":{
"type": "object",
"description": "Nature or use of the account.",
"$ref": "#/definitions/account_type"
},
"Ccy": {
"type": "string",
"description": "Code allocated to identify a currency for the Debtor Agent Account. Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.",
"$ref": "#/definitions/currency",
"pattern": "^[A-Z]{3,3}$"
},
"Nm":{
"type": "string",
"description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.",
"$ref": "#/definitions/account_name",
"maxLength": 140
},
"Prxy":{
"type": "object",
"description": "Specifies an alternate assumed name for the identification of the account.",
"properties": {
"Id": {
"type": "object",
"description": "Unique and unambiguous identification for the account between the account owner and the account servicer.",
"$ref": "#/definitions/account_id"
},
"Tp":{
"type": "object",
"description": "Nature or use of the account.",
"$ref": "#/definitions/account_type"
}
}
}
}
},
"CdtrAgt": {
"type": "object",
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"FinInstnId": {
"type": "object",
"description": "Allows the details of the Creditor Agent to be held",
"$ref": "#/definitions/financial_institution"
},
"BrnchId": {
"type": "object",
"description": "Allows the details of the Creditor Agent Branch to be held",
"$ref": "#/definitions/branch_id"
}
}
},
"Cdtr": {
"type": "object",
"description": "Party to which an amount of money is due.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Creditor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Creditor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Creditor to be held.",
"$ref": "#/definitions/country"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Creditor to be held.",
"$ref": "#/definitions/address"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Creditor to be held.",
"$ref": "#/definitions/contact_details"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Creditor.",
"$ref": "#/definitions/id_section"
}
}
},
"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.",
"properties": {
"Nm": {
"type": "string",
"description": "Name by which the account is known and which is usually used to identify the Creditor account.",
"$ref": "#/definitions/account_name"
},
"Ccy": {
"type": "string",
"description": "Currency for the Creditor Account",
"$ref": "#/definitions/currency"
},
"Id": {
"type": "object",
"description": "Identifier for the Creditor account.",
"$ref": "#/definitions/account_id"
},
"Tp": {
"type": "object",
"description": "Nature or use of the Creditor account.",
"$ref": "#/definitions/account_type"
}
}
},
"UltmtCdtr": {
"type": "object",
"description": "Ultimate party to which an amount of money is due.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Ultimate Creditor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Ultimate Creditor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Utlimate Creditor to be held.",
"$ref": "#/definitions/country"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Ultimate Creditor to be held.",
"$ref": "#/definitions/address"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Ultimate Creditor to be held.",
"$ref": "#/definitions/contact_details"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Ultimate Creditor.",
"$ref": "#/definitions/id_section"
}
}
},
"InstForCdtrAgt": {
"type": "object",
"description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 Instruction3Code List",
"enum": [
"CHQB",
"HOLD",
"PHOB",
"TELB"
]
},
"InstrInf": {
"type": "string",
"description": "Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.",
"maxLength": 140
}
}
},
"Purp": {
"type": "object",
"description": "Underlying reason for the payment transaction.",
"properties": {
"Cd": {
"type": "string",
"description": "Underlying reason for the payment transaction, as published in an external purpose code list. Based on ISO20022 ExternalPurpose1Code List",
"enum": [
"BKDF",
"BKFE",
"BKFM",
"BKIP",
"BKPP",
"CBLK",
"CDCB",
"CDCD",
"CDCS",
"CDDP",
"CDOC",
"CDQC",
"ETUP",
"FAMI",
"FCOL",
"MTUP",
"ACCT",
"CASH",
"COLL",
"CSDB",
"DEPT",
"INTC",
"INTP",
"LIMA",
"NETT",
"BFWD",
"CCIR",
"CCPC",
"CCPM",
"CCSM",
"CRDS",
"CRPR",
"CRSP",
"CRTL",
"EQPT",
"EQUS",
"EXPT",
"EXTD",
"FIXI",
"FWBC",
"FWCC",
"FWSB",
"FWSC",
"MARG",
"MBSB",
"MBSC",
"MGCC",
"MGSC",
"MISC",
"OCCC",
"OPBC",
"OPCC",
"OPSB",
"OPSC",
"OPTN",
"OTCD",
"REMT",
"REPO",
"RPBC",
"RPCC",
"RPSB",
"RPSC",
"RVPO",
"SBSC",
"SCIE",
"SCIR",
"SCRP",
"SHBC",
"SHCC",
"SHSL",
"SLEB",
"SLOA",
"SWBC",
"SWCC",
"SWPT",
"SWSB",
"SWSC",
"TBAS",
"TBBC",
"TBCC",
"TRCP",
"AGRT",
"AREN",
"BEXP",
"BOCE",
"COMC",
"CPYR",
"GDDS",
"GDSV",
"GSCB",
"LICF",
"MP2B",
"POPE",
"ROYA",
"SCVE",
"SUBS",
"SUPP",
"TRAD",
"CHAR",
"COMT",
"MP2P",
"ECPG",
"ECPR",
"ECPU",
"EPAY",
"CLPR",
"COMP",
"DBTC",
"GOVI",
"GIFT",
"HLRP",
"INPC",
"INSU",
"INTE",
"LBRI",
"LIFI",
"LOAN",
"LOAR",
"PENO",
"PPTI",
"RELG",
"RINP",
"TRFD",
"FORW",
"FXNT",
"ADMG",
"ADVA",
"BCDM",
"BCFG",
"BLDM",
"BNET",
"CBFF",
"CBFR",
"CCRD",
"CDBL",
"CFEE",
"CGDD",
"CORT",
"COST",
"CPKC",
"DCRD",
"DSMT",
"DVPM",
"EDUC",
"FACT",
"FAND",
"FCPM",
"FEES",
"GOVT",
"ICCP",
"IDCP",
"IHRP",
"INSM",
"IVPT",
"MCDM",
"MCFG",
"MSVC",
"NOWS",
"OCDM",
"OCFG",
"OFEE",
"OTHR",
"PADD",
"PTSP",
"RCKE",
"RCPT",
"REBT",
"REFU",
"RENT",
"REOD",
"RIMB",
"RPNT",
"RRBN",
"RRTP",
"RVPM",
"SLPI",
"SPLT",
"STDY",
"TBAN",
"TBIL",
"TCSC",
"TELI",
"TMPG",
"TPRI",
"TPRP",
"TRNC",
"TRVC",
"WEBI",
"ANNI",
"CAFI",
"CFDI",
"CMDT",
"DERI",
"DIVD",
"FREX",
"HEDG",
"INVS",
"PRME",
"SAVG",
"SECU",
"SEPI",
"TREA",
"UNIT",
"FNET",
"FUTR",
"ANTS",
"CVCF",
"DMEQ",
"DNTS",
"HLTC",
"HLTI",
"HSPC",
"ICRF",
"LTCF",
"MAFC",
"MDCS",
"VIEW",
"CDEP",
"SWFP",
"SWPP",
"SWRS",
"SWUF",
"ADCS",
"AEMP",
"ALLW",
"ALMY",
"BBSC",
"BECH",
"BENE",
"BONU",
"CCHD",
"COMM",
"CSLP",
"GFRP",
"GVEA",
"GVEB",
"GVEC",
"GVED",
"GWLT",
"HREC",
"PAYR",
"PEFC",
"PENS",
"PRCP",
"RHBS",
"SALA",
"SSBE",
"LBIN",
"LCOL",
"LFEE",
"LMEQ",
"LMFI",
"LMRK",
"LREB",
"LREV",
"LSFL",
"ESTX",
"FWLV",
"GSTX",
"HSTX",
"INTX",
"NITX",
"PTXP",
"RDTX",
"TAXS",
"VATX",
"WHLD",
"TAXR",
"B112",
"BR12",
"TLRF",
"TLRR",
"AIRB",
"BUSB",
"FERB",
"RLWY",
"TRPT",
"CBTV",
"ELEC",
"ENRG",
"GASB",
"NWCH",
"NWCM",
"OTLC",
"PHON",
"UBIL",
"WTER",
"SERV",
"HLST",
"INPR",
"INSC",
"RRCT",
"IPAY",
"IPCA",
"IPDO",
"IPEA",
"IPEC",
"IPEW",
"IPPS",
"IPRT",
"IPU2",
"IPUW",
"SPSP",
"MARF"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"RgltryRptg": {
"type": "object",
"description": "Information needed due to regulatory and statutory requirements.",
"properties": {
"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.",
"enum": [
"CRED",
"DEBT",
"BOTH"
]
},
"Authrty": {
"type": "object",
"description": "Entity requiring the regulatory reporting information.",
"properties": {
"Nm": {
"type": "string",
"description": "Name of the entity requiring the regulatory reporting information.",
"maxLength": 140
},
"Ctry": {
"type": "string",
"description": "Country where Entity resides",
"$ref": "#/definitions/country"
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the regulatory reporting information.",
"properties": {
"Tp": {
"type": "string",
"description": "Specifies the type of the information supplied in the regulatory reporting details.",
"maxLength": 35
},
"Dt": {
"type": "string",
"description": "Date related to the specified type of regulatory reporting details.",
"format": "date-time"
},
"Ctry": {
"$ref": "#/definitions/country"
},
"Cd": {
"type": "string",
"description": "Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.",
"maxLength": 10
},
"Amt": {
"type": "object",
"description": "Amount of money to be reported for regulatory and statutory requirements.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"Ccy": {
"$ref": "#/definitions/currency"
}
}
},
"Inf": {
"type": "string",
"description": "Additional details that cater for specific domestic regulatory requirements.",
"maxLength": 35
}
}
}
}
},
"RltdRmtInf": {
"type": "object",
"description": "Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.",
"properties": {
"RmtId": {
"type": "string",
"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.",
"maxLength": 35
},
"RmtLctnDtls": {
"type": "object",
"description": "Set of elements used to provide information on the location and/or delivery of the remittance information.",
"properties": {
"Mtd": {
"type": "string",
"description": "List based on ISO 20022 RemittanceLocationMethod2Code List",
"enum": [
"FAXI",
"EDIC",
"URID",
"EMAL",
"POST",
"SMSM"
]
},
"ElctrncAdr": {
"type": "string",
"description": "Electronic address to which an agent is to send the remittance information.",
"maxLength": 2048
},
"PstlAdr": {
"type": "object",
"description": "Postal address to which an agent is to send the remittance information.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"Adr": {
"$ref": "#/definitions/address"
}
}
}
}
}
}
},
"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.",
"properties": {
"Ustrd": {
"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. Please note, should new lines be required in this field, \n should be used to denote a new line.",
"type": "string",
"maxLength": 140
},
"Strd": {
"type": "object",
"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.",
"properties": {
"RfrdDocInf": {
"type": "object",
"description": "Provides the identification and the content of the referred document.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document.",
"properties": {
"Cd": {
"type": "string",
"description": "Document type in a coded form. As defined in ISO list DocumentType6Code ",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT",
"PUOR"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary values",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the reference document type.",
"maxLength": 35
}
}
}
},
"Nb": {
"type": "string",
"description": "Unique and unambiguous identification of the referred document.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document.",
"format": "date-time"
},
"LineDtls": {
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": [
{
"Id": {
"type": "object",
"description": "Provides identification of the document line.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document line identification.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document line identification.",
"properties": {
"Cd": {
"type": "string",
"description": "Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code",
"enum": [
"ADPI",
"AISB",
"ASNB",
"CTNB",
"DBSP",
"EANN",
"EINB",
"GSNB",
"HIBC",
"ISBN",
"LTNB",
"MDNB",
"PRNB",
"PTCD",
"SKNB",
"STNB",
"TONB",
"UPCC",
"UPNB"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the reference document line identification type.",
"maxLength": 35
}
},
"Nb": {
"type": "string",
"description": "Identification of the type specified for the referred document line.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document line.",
"format": "date-time"
}
}
},
"Desc": {
"type": "string",
"description": "Description associated with the document line.",
"maxLength": 2048
},
"Amt": {
"type": "object",
"description": "Provides details on the amounts of the document line.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO list ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Amount of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"Prtry": {
"type": "string",
"description": "Specifies the amount type, in a free-text form.",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the adjustment.",
"properties": {
"Amt": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be substracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
]
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
}
}
}
}]
}
}
},
"RfrdDocAmt": {
"type": "object",
"description": "Provides details on the amounts of the referred document.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Quantity of cash resulting from the calculation of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount. Based on the ISO ExternalTaxAmountType1Code list",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on the ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the document adjustment.",
"properties": {
"Amt": {
"type": "object",
"description": "Amount of money of the document adjustment.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be substracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
]
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtrRefInf": {
"type": "object",
"description": "Reference information provided by the creditor to allow the identification of the underlying documents.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of creditor reference.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Coded or proprietary format creditor reference type.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of creditor reference, in a coded form. Based on ISO DocumentType3Code list",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
]
},
"Prtry": {
"type": "string",
"description": "Creditor reference type, in a proprietary form.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the credit reference type.",
"maxLength": 35
}
}
},
"Ref": {
"type": "string",
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.",
"maxLength": 35
}
}
},
"Invcr": {
"type": "object",
"description": "Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"Invcee": {
"type": "object",
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"TaxRmt": {
"type": "object",
"description": "Provides remittance information about a payment made for tax-related purposes.",
"properties": {
"Cdtr": {
"type": "object",
"description": "Party on the credit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the creditor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
}
}
},
"Dbtr": {
"type": "object",
"description": "Identifies the party on the debit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"AdmstnZone": {
"type": "string",
"description": "Territorial part of a country to which the tax payment is related.",
"maxLength": 35
},
"RefNb": {
"type": "string",
"description": "Tax reference information that is specific to a taxing agency.",
"maxLength": 140
},
"Mtd": {
"type": "string",
"description": "Method used to indicate the underlying business or how the tax is paid.",
"maxLength": 35
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Total amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TtlTaxAmt": {
"type": "object",
"description": "Total amount of money as result of the calculation of the tax.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"Dt": {
"type": "string",
"description": "Date by which tax is due.",
"format": "date-time"
},
"SeqNb": {
"type": "integer",
"description": "Sequential number of the tax report."
},
"Rcrd": {
"type": "object",
"description": "Record of tax details.",
"properties": {
"Tp": {
"type": "string",
"description": "High level code to identify the type of tax details.",
"maxLength": 35
},
"Ctgy": {
"type": "string",
"description": "Specifies the tax code as published by the tax authority.",
"maxLength": 35
},
"CtgyDtls": {
"type": "string",
"description": "Provides further details of the category tax code.",
"maxLength": 35
},
"DbtrSts": {
"type": "string",
"description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.",
"maxLength": 35
},
"CertId": {
"type": "string",
"description": "Identification number of the tax report as assigned by the taxing authority.",
"maxLength": 35
},
"FrmsCd": {
"type": "string",
"description": "Identifies, in a coded form, on which template the tax report is to be provided.",
"maxLength": 35
},
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date-time"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date-time"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date-time"
}
}
}
}
},
"TaxAmt": {
"type": "object",
"description": "Set of elements used to provide information on the amount of the tax record.",
"properties": {
"Rate": {
"type": "number",
"description": "Rate used to calculate the tax. ",
"minimum": 0,
"maximum": 100,
"multiplpeOf": 1e-10
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TtlAmt": {
"type": "object",
"description": "Total amount that is the result of the calculation of the tax for the record.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the tax period and amount.",
"properties": {
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date-time"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date-time"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date-time"
}
}
}
}
},
"Amt": {
"type": "object",
"description": "Underlying tax amount related to the specified period.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AddtlInf": {
"type": "string",
"description": "Further details of the tax record.",
"maxLength": 140
}
}
}
}
}
}
},
"GrnshmtRmt": {
"type": "object",
"description": "Provides remittance information about a payment for garnishment-related purposes.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of garnishment.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the garnishment.",
"properties": {
"Cd": {
"type": "string",
"description": "Garnishment type in a coded form. Based on ISO ExternalGarnishmentType1Code list",
"enum": [
"GNCS",
"GNDP",
"GTPP"
]
},
"Prtry": {
"type": "string",
"description": "Proprietary identification of the type of garnishment.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the garnishment type.",
"maxLength": 35
}
}
},
"Grnshee": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"GrnshmyAdmstr": {
"type": "object",
"description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"RefNb": {
"type": "string",
"description": "Reference information that is specific to the agency receiving the garnishment.",
"maxLength": 140
},
"Dt": {
"type": "string",
"description": "Date of payment which garnishment was taken from.",
"format": "date-time"
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"FmlyMdcllnsrncInd": {
"type": "boolean",
"description": "Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available."
},
"MplyeeTermntnInd": {
"type": "boolean",
"description": "Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated."
}
}
},
"AddtlRmtInf": {
"type": "array",
"description": "Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification."
}
}
}
}
},
"original_message_pacs008": {
"type": "string",
"description": "Provides the ability to include the original PACS.008 message"
},
"original_message_mt103": {
"type": "string",
"description": "Provides the ability to include the original MT103 message"
}
}
}