An external card (eac_*) is a card from another bank that a user adds on the dashboard. It isn’t a payer card saved at checkout with a Natural merchant. An agent pays with one through browser tokens or agent tokens. To compare it with Natural-issued cards, see External and Natural-issued cards.
The object is each element of data; this shows the first one. The field names below are relative to it: attributes.brand is data[].attributes.brand in the response.
Card expiry month, 1 to 12. Null when the expiry is not on file.
integer | null
required
Card expiry year, four digits. Null when the expiry is not on file.
string
required
Name the customer gave the card, e.g. “Work Amex”. Defaults to <Brand> card ending <last4>.
object | null
required
The card’s billing address on file, for filling a merchant’s checkout (the ZIP drives the bank’s AVS check).
Hide billingAddress
string | null
required
First line of the street address, or null.
string | null
required
Second line of the street address, or null.
string | null
required
City, or null.
string | null
required
State or region, or null.
string | null
required
ZIP/postal code the bank’s AVS check validates at checkout.
string | null
required
Country, or null.
string
required
Lifecycle status of the external card. One of: pending, new, active, disabled, deleted, unknown, verification_failed. See Statuses.
string
required
Time when the card was linked.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party that owns the external account.
Hide party
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
Statuses
Status
Meaning
Can become
pending
Not returned today.
Final
new
Not returned today.
Final
active
Saved and usable for card payments and card sessions.
disabled
disabled
Removed. Only the remove response shows it; the list leaves it out.
Final
deleted
Not returned today.
Final
unknown
Not returned today.
Final
verification_failed
Not returned today.
Final
Permissions
Listing external cards needs externalAccounts.read or savedCards.use. An API key gets externalAccounts.read with the wallets.read scope. Removing one needs savedCards.use. Listing them doesn’t let an agent pay with them.
Removing a card
When you remove a customer’s card, Natural emails the customer, if they have an email address, and names your business. A card session already open on the card can’t be approved after that.