Account attributes
Required attributes
If an attribute is not defined for an account, it is inherited from its program. Certain attributes are required, depending on the account type.
Attribute | Description |
---|---|
|
If you don't use Tip: If you have the |
| Flag that determines whether to create the account immediately ( If If |
| Attributes and objects of the customer who is the account holder. This object requires a See Working with customer objects and Working with address and phone objects. |
| (Required for credit programs only) Monthly cycle date. Every account has a starting date for the monthly accounting cycle. For credit cards, this date is the statement's due date. For checking accounts, prepaid cards, and debit cards, this date is usually set to the first day of the month and is used to group together monthly transactions. Important: The To get a list of due dates available for a particular program, see Get List of Program Due Dates. |
Account limits
For information about an account's limits attributes, see Account limits.
Additional account attributes
Besides registration data, the Pismo platform enables you to set some additional attributes related to the account
exchange_mode
– Exchange conversion rule for purchases in foreign currencies. Valid values areSAME_DAY
for rate conversions at the purchase day orCLOSING
for rates applied at the statement's cycle closing date (also valid only for credit programs).- Limits (see Account limits
For more information, see Account attributes .
Optional account attributes
The account object can receive the following optional attributes.
external_id
– A custom account ID string that uniquely identifies the account within your organization.
Relationship between external_id
and documentNumber
external_id
and documentNumber
The external_id
parameter is a unique external ID that you can add to an account. This parameter is not validated, so you can set a provide a string value according to your business needs.
By default, external_id
is not set and the documentNumber
is used to identify the account within the program. (Remember, by default there can be only one account per documentNumber
in the same program.) However, if you set an external_id
, this documentNumber
uniqueness rule is not applied, so you can have multiple accounts that use the same documentNumber
.
Some older Pismo customers might still be using the legacy program parameter
ALLOW MULTI ACCOUNTS FOR CREDENTIAL
for this purpose. When this boolean parameter is set totrue
, thedocumentNumber
uniqueness per program rule is not applied when creating an account in the program.
Custom account attributes
The Accounts API also allows for persisting custom metadata associated with the customer, using the custom_fields
object as a general key-value store. For example, you could store information like:
{
"preferred-social-network": "facebook",
"discounts-of-interest": ["restaurants", "movies"]
}
Optional application data
birth_date
account
Personal and company attributes
See Working with customer objects.
Address and phone attributes
Updated 16 days ago