Payment

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

amount
required
number <double>

The amount of this payment, excluding tips.

amountTendered
number <double>

The amount tendered for this payment.

cardEntryMode
string

Indicates how credit card data was obtained.

Enum: "SWIPED" "KEYED" "ONLINE" "EMV_CHIP_SIGN" "TOKENIZED" "PRE_AUTHED" "SAVED_CARD" "FUTURE_ORDER"
cardType
string

The type of card used.

Enum: "VISA" "MASTERCARD" "AMEX" "DISCOVER" "JCB" "DINERS" "CIT" "MAESTRO" "LASER" "SOLO" "UNKNOWN"
object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

object (Device)

The Device ID value that the Toast POS system assigns to a specific Toast POS device. The id value is a unique identifier for a device. To find the ID for a Toast POS device, do the following. From the overflow menu (⋮) select Device Status and then select the Device tab.

entityType
required
string

The type of object this is.

externalId
string

External identifier string that is prefixed by the naming authority.

guid
required
string

The GUID maintained by Toast.

object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

last4Digits
string

The last 4 digits of the card used.

object (Device)

The Device ID value that the Toast POS system assigns to a specific Toast POS device. The id value is a unique identifier for a device. To find the ID for a Toast POS device, do the following. From the overflow menu (⋮) select Device Status and then select the Device tab.

mcaRepaymentAmount
number <double>

The total currency amount withheld as repayment for a merchant cash advance (MCA). The MCA repayment amount is set at the time the payment is captured, and then updated when settlement occurs.

originalProcessingFee
number <double>

The original processing fee for this payment. The original processing fee value is populated after the payment has been captured.

object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

paidBusinessDate
integer

The business date (yyyyMMdd) on which this payment was first applied.

paidDate
string <date-time>

The date on which the payment was made. Use ISO 8601 date and time format for all Toast APIs.

paymentStatus
string

The status of this payment when the type is CREDIT.

Enum: "OPEN" "PROCESSING" "AUTHORIZED_AT_RISK" "AUTHORIZED" "ERROR" "DENIED" "VOIDED_AT_RISK" "CANCELLED" "CAPTURE_IN_PROGRESS" "CAPTURED" "VOIDED"
object (Refund)

A discount applied to a check or item.

refundStatus
string
Enum: "NONE" "PARTIAL" "FULL"
tipAmount
required
number <double>

The amount tipped on this payment.

type
required
string

The payment method.

Enum: "CASH" "CREDIT" "GIFTCARD" "HOUSE_ACCOUNT" "REWARDCARD" "LEVELUP" "TENDER" "OTHER" "UNDETERMINED"
object (VoidInformation)

Information about a void applied to a check or item.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "paidDate": "2019-08-24T14:15:22Z",
  • "paidBusinessDate": 0,
  • "type": "CASH",
  • "cardEntryMode": "SWIPED",
  • "amount": 0,
  • "tipAmount": 0,
  • "amountTendered": 0,
  • "cardType": "VISA",
  • "last4Digits": "string",
  • "originalProcessingFee": 0,
  • "cashDrawer": {
    },
  • "refundStatus": "NONE",
  • "refund": {
    },
  • "paymentStatus": "OPEN",
  • "voidInfo": {
    },
  • "houseAccount": {
    },
  • "otherPayment": {
    },
  • "createdDevice": {
    },
  • "lastModifiedDevice": {
    },
  • "mcaRepaymentAmount": 0
}