The orders API includes a networkTransactionIdentifier
value in the OrderPayment object that contains a unique
identifier provided by a card network when a credit card payment is
authorized. This unique identifier lets you identify guests using a specific
card network like American Express™, Visa™, or Mastercard™.
When a credit card payment is authorized for an order, the card
network generates a unique transaction identifier. The Toast platform
captures this identifier and includes it in the
networkTransactionIdentifier value of the
OrderPayment object. The identifier is a string that
identifies the card network.
The networkTransactionIdentifier value is available
in:
-
Order webhook payloads when order updates are sent to subscribers.
-
Orders API read endpoints when you retrieve order information.
The networkTransactionIdentifier is provided by the
card network when a payment is authorized. The identifier is not available
for payments that were processed before April 1, 2026 and historical
orders are not updated with this information.
Note: A check can have multiple
payments applied to it. The networkTransactionIdentifier is
associated with each individual payment, not with specific items on the
check. All payments on a check apply to the total check amount, and the
Toast platform does not track which items are paid for by which payment
method. If you need to determine which items should be associated with a
particular payment, you must implement your own logic to handle this
scenario.
The networkTransactionIdentifier value is a string in
the OrderPayment object. This value is only populated for
credit card payments that have been authorized. The value is null for cash
payments, alternative payment types, other non-credit card payment
methods, and for payments that have not yet been authorized.
The following example shows an OrderPayment object that
includes the networkTransactionIdentifier value.
{
"guid": "a9d4f8e2-7c3b-4a5e-9b2d-6f1c8e4a7b3d",
"entityType": "OrderPayment",
"networkTransactionIdentifier": "e8f7a6b5-4c3d-2e1f-9a8b-7c6d5e4f3a2b",
"externalId": null,
"type": "CREDIT",
"amount": 6.17,
"tipAmount": 0.0,
"paymentStatus": "CAPTURED",
"paidDate": "2025-12-29T14:37:05.298+0000",
}
When you subscribe to order webhooks, the webhook payloads include
the networkTransactionIdentifier value in
OrderPayment objects for payments that are authorized. The
identifier is included in the full order JSON that is sent in webhook
events.
The identifier is available in webhook payloads for order events that occur after a payment has been authorized. This includes order update events and order creation events when payments are included with the order.
For more information about order webhooks, see Order webhooks.
When you get order information using the orders API endpoints, the
response includes the networkTransactionIdentifier value in
OrderPayment objects for authorized credit card
payments.
The identifier is available in responses from the following endpoints:
-
GET /orders/{orderGuid}: Get a single order.
-
GET /ordersBulk: Get multiple orders.
For more information about retrieving orders, see Getting detailed information about a single order and Getting detailed information about multiple orders.
The following example shows a portion of an order response that
includes the networkTransactionIdentifier value in the
payments object.
{
"guid": "f47a2c91-8d3b-4e2a-9f1c-7b6e5a4d8c2f",
"entityType": "Order",
"checks": [
{
"guid": "3b8e9c4d-2a1f-4e6b-8c3d-5f7a9b2e1c4d",
"entityType": "Check",
"payments": [
{
"guid": "a9d4f8e2-7c3b-4a5e-9b2d-6f1c8e4a7b3d",
"entityType": "OrderPayment",
"networkTransactionIdentifier": "e8f7a6b5-4c3d-2e1f-9a8b-7c6d5e4f3a2b",
"type": "CREDIT",
"amount": 6.17,
"tipAmount": 0.0,
"paymentStatus": "CAPTURED",
"paidDate": "2025-12-29T14:37:05.298+0000",
[additional fields omitted]
}
],
[additional check fields omitted]
}
],
[additional order fields omitted]
}