You can get the first name and last name of the credit card account holder for a Toast order payment from the orders API.
When credit card account holder information is available in the orders
API response data, the Payment object for a Check
object in the Order includes a cardHolderFirstName
value and a cardHolderLastName value.
Credit card account holder name information is available in
Payment objects from all orders API endpoints that return
Order objects. For information about getting order information,
see Orders API overview.
The Toast platform significantly restricts access to sensitive personal information about credit card account holders.
You can only get access to the first name and last name of a credit card account holder for an order payment if the following conditions are met:
-
The restaurant location that processed the order has chosen to share credit card account holder names. Restaurant locations must explicitly choose to share credit card account holder names in orders API response data.
-
Your Toast API client must have permission to access credit card account holder name information. Toast support gives your client access to credit card account holder names. This information access is in limited release.
If a restaurant does not choose to share credit card account holder
name, or if your Toast API client does not have access to credit card
account holder name information, then the Payment object does
not include a cardHolderFirstName value or a
cardHolderLastName value.
Credit card account holder name information is only available for orders if the following conditions are met:
-
The order was processed using the Toast POS app. Toast POS app orders are orders that are processed on-premise at restaurant locations.
Card account holder information is not available for online orders that were processed using the orders API. This includes orders processed using a Toast Online Ordering web site, Toast order and pay at the table, or an ordering service such as GrubHub™, DoorDash™, and UberEats™.
-
The payment type is credit card.
Card account holder information is not available for other payment types such as cash payments or gift cards.
-
The credit card payment was taken by physically swiping the card.
Card account holder information is not available for orders where the credit card payment was keyed in using the credit card number.
For orders that do not include credit card account holder name
information, the cardHolderFirstName and
cardHolderLastName values for a Payment object
are null.
The following example shows credit card account holder name
information in an Order object returned in orders API
response data.
{
"entityType": "Order",
[contents omitted]
"checks": [
{
"entityType": "Check",
[contents omitted]
"payments": [
{
"entityType": "OrderPayment",
[contents omitted]
"cardHolderLastName": "Laurent",
"type": "CREDIT",
[contents omitted]
"cardEntryMode": "SWIPED",
[contents omitted]
"cardHolderFirstName": "Jacques-Etienne",
[contents omitted]
}
],
[contents omitted]
}
],
[contents omitted]
}|
The first name, or personal name, of the credit card account holder. |
|
|
The orders API only returns credit card account holder name information for credit card payments. |
|
|
The orders API only returns credit card account holder name information for credit card payments that are physically swiped in a card reader device. |
|
|
The last name, or family name, of the credit card account holder. |