Skip to content

Dbtr

Party that owes an amount of money to the (ultimate) creditor.

  • Is optional
  • Type: object

With the following properties:

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

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

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

Defined in #/definitions/fullname
PstlAdrObjectThe PstlAdr property is required.
All other properties are optional.		Allows the address of the Debtor to be held.
StrdNmObjectRequired if the Debtor is an individual.

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

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

PstlAdr

Allows the address of the Debtor to be held.

The full list of PstlAdr properties is defined in #/definitions/address. However, the following property is required for Dbtr.PstlAdr:

PropertyTypeRequiredDescription
CtryReferenceRequiredInformation 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.
An example of a valid country code is "HK" for Hong Kong, or "DK" for Denmark.

If you are specifying additional PstlAdr properties, you must adhere to the format defined in #/definitions/address.

StrdNm

Allows the name of the Debtor 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 Dbtr.StrdNm:

PropertyTypeRequiredDescription
FirstNmStringRequired if the Debtor 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, they must be separated by a space.
    For example, if the Debtor'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 Debtor is an organization.
LastNmStringRequired if the Debtor 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, they must be separated by a space.
    For example, if the Debtor'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 Debtor is an organization.

JSON schema extract

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