GUguesty
Reservation Payments

List reservation payments

Changed on

Returns every payment on the given reservation, including authorization holds and their capture payments, plus reservation payment summary fields.

get/payments

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/payments
  • Auth
    API key in header authorization

Query parameters

reservationIdstring required
Example:6213b03e7f0ba50032296f4a

Guesty reservation id

Response

The reservation payments and payment summary

balanceDuenumber required

Remaining balance due on the reservation

paymentsDuenumber required

Sum of pending payments due on the reservation

totalPaidnumber required

Total amount paid on the reservation

totalRefundednumber required

Total amount refunded on the reservation

totalPaymentFeesnumber

Total payment fees on the reservation

isFullyPaidboolean required

Whether the reservation is fully paid

isTouchedPaymentsboolean required

Whether any payments have been created on the reservation

currencystring required

ISO 4217 currency code of the reservation

hostPayoutnumber required

Host payout amount for the reservation

Example response

{
  "payments": [
    {
      "_id": "64da25d683ad1500284bd0ef",
      "reservationId": "6213b03e7f0ba50032296f4a",
      "accountId": "5f293ca69fa6bd01659b645e",
      "paymentMethodId": "5f92cbf10cf217478ba93561",
      "paymentMethodStatus": "ACTIVE",
      "status": "SUCCEEDED",
      "amount": 150,
      "currency": "USD",
      "type": "REFUNDABLE_DEPOSIT",
      "confirmationCode": "pi_3UITWaE5puWDpHmg1fPNH1ZL",
      "shouldBePaidAt": "2026-10-01T12:00:00.000Z",
      "paidAt": "2026-10-01T12:00:05.000Z",
      "cancelledAt": "2026-10-01T12:00:05.000Z",
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:00:05.000Z",
      "note": "Charge remaining balance",
      "receiptId": 146928316,
      "createdBy": "host@example.com",
      "error": "CARD_DECLINED",
      "processorError": {
        "code": "card_declined",
        "message": "Your card was declined."
      },
      "authenticationRequiredData": {
        "lastAuthMsgSentDate": "2026-10-01T12:00:00.000Z",
        "authenticationUrl": "https://hooks.stripe.com/redirect/authenticate/..."
      },
      "captureAuthorizationHold": {
        "amount": 150,
        "status": "PENDING",
        "shouldTriggerAt": "2026-10-15T12:00:00.000Z",
        "cancelledAt": "2026-10-10T12:00:00.000Z",
        "note": "Guest checked out early"
      },
      "releaseAuthorizationHold": {
        "amount": 150,
        "status": "PENDING",
        "shouldTriggerAt": "2026-10-15T12:00:00.000Z",
        "cancelledAt": "2026-10-10T12:00:00.000Z",
        "note": "Guest checked out early"
      },
      "authorizationHoldCaptures": [
        {
          "_id": "64da25d683ad1500284bd0ef",
          "amount": 100,
          "status": "SUCCEEDED",
          "createdAt": "2026-10-01T12:00:00.000Z",
          "note": "Partial capture for remaining balance"
        }
      ],
      "refunds": [
        {
          "_id": "64da267d83ad1500284bd109",
          "amount": 50,
          "status": "SUCCEEDED",
          "createdAt": "2026-10-01T12:00:00.000Z",
          "refundedAt": "2026-10-01T12:00:05.000Z",
          "note": "Guest cancelled",
          "paymentMethodId": "5f92cbf10cf217478ba93561",
          "processorError": {
            "code": "card_declined",
            "message": "Your card was declined."
          }
        }
      ],
      "chargebacksData": {
        "chargebackPaymentMethodId": "5f92cbf10cf217478ba93561",
        "chargebacks": [
          {
            "_id": "64da267d83ad1500284bd109",
            "amount": 150,
            "type": "CHARGEBACK",
            "chargebackAt": "2026-10-01T12:00:00.000Z",
            "createdAt": "2026-10-01T12:00:00.000Z",
            "source": "MANUAL",
            "reason": "Fraudulent charge",
            "reasonCode": "10.4",
            "reasonDescription": "Fraud – Card-Absent Environment",
            "note": "Disputed by guest",
            "caseId": "dp_1N...",
            "transactionId": "ch_3N..."
          }
        ]
      },
      "attempts": [
        {
          "_id": "64da267d83ad1500284bd109",
          "status": "FAILED",
          "createdAt": "2026-10-01T12:00:00.000Z",
          "error": "CARD_DECLINED",
          "processorError": {
            "code": "card_declined",
            "message": "Your card was declined."
          }
        }
      ],
      "fees": [
        {
          "_id": "64da267d83ad1500284bd109",
          "amount": 2.5
        }
      ],
      "isInstantCharge": true,
      "payoutId": "PO-123456"
    }
  ],
  "balanceDue": 150,
  "paymentsDue": 50,
  "totalPaid": 100,
  "totalPaymentFees": 2.5,
  "isTouchedPayments": true,
  "invalidCreditCard": {
    "brand": "visa",
    "last4": "4242",
    "error": "CARD_DECLINED"
  },
  "currency": "USD",
  "hostPayout": 250
}

Changes