Dbtr

For third-party payments, the Dbtr object contains information about the debtor (also known as the originator) on behalf of who 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. See the table below, or download the Dbtr schema.

Note

When you're creating 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.

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.