PaymentStatus

Status of a payment.

amount
object

The amount of this payment, not including tip.

object (AuthorizationMetadata)

Additional details about a payment, typically displayed on a receipt and logged by the partner.

denialReason
string

The reason a payment was denied. This must be displayed to the consumer.

error
string

If the payment is in an error state, this will contain the error.

paymentState
required
string

The state of the payment. Toast may add values to this field. Make sure that your implementation can handle additional values.

Enum: "AUTHORIZED" "ACKNOWLEDGED" "DENIED"
tipAmount
object

The tip amount of this payment.

{
  • "paymentState": "AUTHORIZED",
  • "authorizationMetadata": {
    },
  • "amount": { },
  • "tipAmount": { },
  • "denialReason": "string",
  • "error": "string"
}