Skip to content

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.
Dbtrobjectrequired

Party that owes an amount of money to the creditor.

Dbtr.​Nmstring[ 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.

Dbtr.​PstlAdrobject

The address of the party who is originating the payment.

Dbtr.​Idobject

Unique and unambiguous way to identify the Debtor.

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.
Dbtrobjectrequired

Party that owes an amount of money to the creditor.

Dbtr.​CtctDtlsobject

Allows the contact information for the Debtor to be held.

Dbtr.​StrdNmobject

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

Dbtr.​Idobject

Unique and unambiguous way to identify the Debtor.

Dbtr.​PstlAdrobject

Allows the address of the Debtor to be held.