Cdtr

The Cdtr object contains information about the creditor (also known as the beneficiary) such as their name, contact information, and address. This information is provided using objects nested within the Cdtr object.

Note

When you're creating an identity, the Cdtr object fields you need to include may vary based on the data required for a specific beneficiary country and currency. For more information, see Get data requirements.

The beneficiary you are paying may be an individual or a business. See the following sections for the Cdtr object schemas for each beneficiary type.

Business beneficiary schema

See the table below, or download the business beneficiary Cdtr schema.

Expand to see the Cdtr object schema for a business beneficiary.

Cdtrobjectrequired

Party to which an amount of money is due.

Cdtr.Nmstring[ 1 .. 140 ] characters^[a-zA-Z0-9 \t]+$

Allows the name of the Creditor to be held as a single value.

• Required if the creditor is an organization.

Requirements:

• Must include one (1) name string.

• Allowable characters: Alphanumeric and space.

• Names with multiple words must be separated by a space. For example, specify "Widgets Org", as Widgets Org.

• Provide a truncated name if longer than 140 characters.

Cdtr.CtryOfResstring^[A-Z]{2}$

Allows the Country of Residence of the Creditor to be held. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Cdtr.PstlAdrobject

Allows the address of the Creditor to be held.

Cdtr.CtctDtlsobject

Allows the contact of the Creditor to be held.

Cdtr.Idobject

Unique and unambiguous way to identify the Creditor.

Individual beneficiary schema

See the table below, or download the individual beneficiary Cdtr schema.

Expand to see the Cdtr object schema for an individual beneficiary.

Cdtrobjectrequired

Party to which an amount of money is due.

Cdtr.StrdNmobject

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

• Required if the creditor is an individual.