Skip to content

CdtrRefInf

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

With the following properties:

PropertyTypeRequiredDescription
TpObjectOptionalSpecifies the type of creditor reference.
RefStringOptionalUnique 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:

PropertyTypeRequiredDescription
CdOrPrtryObjectOptionalCoded or proprietary format creditor Reference type.
IssrStringOptionalEntity that assigns the credit Reference type. Maximum length 35 characters

CdOrPrtry

Coded or proprietary format creditor Reference type.

With the following properties:

PropertyTypeRequiredDescription
CdStringOptionalType 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.
PrtryStringOptionalCreditor Reference type, in a proprietary form. Maximum length 35 characters
Cd known values
ValueDescription
RADMRemittance Advice Message
RPINRelated Payment Instruction
FXDRForeign Exchange Deal Reference
DISPDispatch Advice
PUORPurchase Order
SCORStructured Communication Reference

JSON schema extract

"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
            }
        }
    }