Get a payment

Returns a JSON Payment object containing detailed information about a single payment, specified by its GUID.

Securityoauth2

Request

path Parameters

• guid required:
  string

  The GUID for the payment you want to return.

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The GUID of the restaurant used as the context of the request.

Responses

200

Returns a JSON Payment object.

400

The GUID was malformed.

404

The specified payment was not found.

get /payments/{guid}

Request samples

curl -i -X GET \
  'https://toast-api-server/orders/v2/payments/{guid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "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,
  "server": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string"
  },
  "cashDrawer": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string"
  },
  "refundStatus": "NONE",
  "refund": {
    "refundAmount": 0,
    "tipRefundAmount": 0,
    "refundDate": "2019-08-24T14:15:22Z",
    "refundBusinessDate": 0,
    "refundTransaction": {
      "guid": "string",
      "entityType": "string"
    }
  },
  "paymentStatus": "OPEN",
  "voidInfo": {
    "voidUser": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "voidApprover": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    },
    "voidDate": "2019-08-24T14:15:22Z",
    "voidBusinessDate": 0,
    "voidReason": {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    }
  },
  "houseAccount": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string"
  },
  "otherPayment": {
    "guid": "string",
    "entityType": "string",
    "externalId": "string"
  },
  "createdDevice": {
    "id": "string"
  },
  "lastModifiedDevice": {
    "id": "string"
  },
  "mcaRepaymentAmount": 0,
  "cardPaymentId": "string",
  "orderGuid": "string",
  "checkGuid": "string",
  "tenderTransactionGuid": "string"
}