Dbtr

For third-party payments, the Dbtr object contains information about the debtor (also known as the originator) on behalf of whom you're processing this payment. This object contains information such as their name, contact information, and address. This information is provided using objects nested within the Dbtr object.

Note

When you create an identity, the Dbtr object fields you need to include may vary based on the data required for a specific originator country. For more information, see Get data requirements.

Business originator schema

See the table below, or download the business originator Dbtr schema.

Expand to see the Dbtr object schema for a business originator.

required

object

Party that owes an amount of money to the creditor.

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

Allows the name of the Debtor to be held as a single value.
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.

object

The address of the party who is originating the payment.

AdrLine	Array of arrays <= 70 characters Information that locates and identifies the street address for the party, as defined by postal services.
PstCd	string <= 16 characters Information that locates and identifies the postal code for the party, as defined by postal services.
TwnNm	string <= 35 characters Information that locates and identifies the party's city or town name, as defined by postal services.
Ctry required	string^[A-Z]{2}$ Information 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.

object

Unique and unambiguous way to identify the Debtor.

object

Unique and unambiguous way to identify an individual or organization.

Individual originator schema

See the table below, or download the individual originator Dbtr schema.

Expand to see the Dbtr object schema for an individual originator.

required

object

Party that owes an amount of money to the creditor.

object

Allows the contact information for the Debtor to be held.

MobNb

required

string [ 0 .. 30 ] characters

The originator's phone number including country code

object

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

LastNm

required

string [ 0 .. 50 ] characters /^[a-zA-Z ]+$/

Last name by which the party is known and which is usually used to identify the party.
Requirements

Must include one (1) name string.
If the last name has two or more words, separate them with a space.
Provide a truncated name if longer than allowable characters.
Do not use this field to specify the individual's middle name.

Example

If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the StrdNm.LastNm value must be 'Iglesias Preysler'.

FirstNm

required

string [ 0 .. 50 ] characters /^[a-zA-Z ]+$/

First name by which the party is known and which is usually used to identify the party.
Requirements

Must include one (1) name string.
If the first name has two or more words, separate them with a space.
Do not use this field to specify the individual's middle name. Use StrdNm.MidNm instead.
Provide a truncated name if longer than allowable characters.

Example

If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the StrdNm.FirstNm value must be 'Norma Jean'.

object

Unique and unambiguous way to identify the Debtor.

object

Unique and unambiguous identification of a person, for example, passport.

object

Allows the address of the Debtor to be held.

AdrLine required	Array of arrays [ 0 .. 50 ] characters Information that locates and identifies the street address for the party, as defined by postal services.
PstCd required	string [ 0 .. 30 ] characters Information that locates and identifies the postal code for the party, as defined by postal services.
TwnNm required	string [ 0 .. 30 ] characters Information that locates and identifies the party's city or town name, as defined by postal services.
Ctry required	string [ 0 .. 2 ] characters Information 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.