CdtrRefInf

Reference information provided by the creditor to allow the identification of the underlying documents.

With the following properties:

Property Type Required Description
Tp Object Optional Specifies the type of creditor reference.
Ref String Optional Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Maximum length 35 characters

Tp

Specifies the type of creditor reference.

With the following properties:

Property Type Required Description
CdOrPrtry Object Optional Coded or proprietary format creditor Reference type.
Issr String Optional Entity that assigns the credit Reference type. Maximum length 35 characters

CdOrPrtry

Coded or proprietary format creditor Reference type.

With the following properties:

Property Type Required Description
Cd String Optional Type of creditor reference, in a coded form. Based on ISO DocumentType3Code list, the value of this property must be equal to one of the known values below.
Prtry String Optional Creditor Reference type, in a proprietary form. Maximum length 35 characters
Cd known values
Value Description
RADM Remittance Advice Message
RPIN Related Payment Instruction
FXDR Foreign Exchange Deal Reference
DISP Dispatch Advice
PUOR Purchase Order
SCOR Structured Communication Reference

JSON schema extract

Copy
Copied!
"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
            }
        }
    }