Skip to content

Cdtr

Party to which an amount of money is due.

  • Is optional
  • Type: object

With the following properties:

PropertyTypeRequiredDescription
CtctDtlsObjectOptionalAllows the contact of the creditor to be held. Defined in #/definitions/contact_details
CtryOfResObjectOptionalAllows the Country of Residence of the creditor to be held. Defined in #/definitions/country
IdObjectOptionalUnique and unambiguous way to identify the creditor. Defined in #/definitions/id_section
NmStringRequired if the creditor is an organization.

Not applicable if the creditor is an individual.		Allows the name of the creditor to be held as a single value.

If the creditor is an individual, specify StrdNm instead of Nm.

Defined in #/definitions/fullname
PstlAdrObjectOptionalAllows the address of the creditor to be held. Defined in #/definitions/address
StrdNmObjectRequired if the creditor is an individual.

Not applicable if the creditor is an organization.		Allows the name of the creditor to be held in a structured format.

If the creditor is an organization, use Nm instead of StrdNm.

StrdNm

Allows the name of the creditor to be held in a structured format.

The full list of StrdNm properties is defined in #/definitions/name. However, the following properties are required for Cdtr.StrdNm:

PropertyTypeRequiredDescription
FirstNmStringRequired if the creditor is an individualFirst name by which the party is known and which is usually used to identify the party.

Usage Guidelines:
  • Must contain at least one (1) name string.
  • No punctuation or special characters may be used.
  • Maximum length: 30 characters. If the first name is longer than the maximum allowed length, provide a truncated value.
  • If the first name has multiple words, separate them by a space.
    For example, if the creditor's full name is August Gray Wyatt where August Gray is the first name, the StrdNm.FirstNm value must be "August Gray".
  • Do not use this field to specify the individual's middle name. Use StrdNm.MidNm instead.
  • Do not use this field if the creditor is an organization.
LastNmStringRequired if the creditor is an individualLast name by which the party is known and which is usually used to identify the party.

Usage Guidelines
  • Must contain at least one (1) name string.
  • No punctuation or special characters may be used.
  • Maximum length: 30 characters. If the last name is longer than the maximum allowed length, provide a truncated value.
  • If the last name has multiple words, separate them by a space.
    For example, if the creditor's full name is August Romero Wyatt where Romero Wyatt is the last name, the StrdNm.LastNm value must be "Romero Wyatt".
  • Do not use this field to specify the individual's middle name. Use StrdNm.MidNm instead.
  • Do not use this field if the creditor is an organization.

JSON schema extract

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