GUguesty
Payment Methods

Get payment method

Changed on

Returns a payment method by ID.

get/payment-methods/{paymentMethodId}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/payment-methods/{paymentMethodId}
  • Auth
    API key in header authorization

Path parameters

paymentMethodIdstring required
Example:5f92cbf10cf217478ba93561

Guesty payment method id

Response

The payment method

_idstring required

Guesty payment method id

accountIdstring

Guesty account id

guestIdstring

Guesty guest id

paymentProviderIdstring

Provider used when the card was tokenized

methodstring required

Payment method

payloadobject

Provider-specific payload

saveForFutureUseboolean

Whether this payment method is kept on the guest

reuseboolean

Whether this payment method can be reused on the guest's other reservations

last4string

Last four digits of the card, when the method is a card

brandstring

Card brand, when the method is a card

status'ACTIVE' | 'INVALID' | 'PENDING_ACTIVATION' | 'INCOMPLETE' | 'CANCELLED' | 'FAILED' | 'DELETED' required

Payment method status

type'PHYSICAL' | 'VIRTUAL' | 'ACH'

Payment method type

confirmationCodestring

Booking confirmation code sent when the payment method was added (for example GY-123456).

createdAtstring date-time

When the payment method was created. Format: YYYY-MM-DDTHH:mm:ss.SSSZ.

updatedAtstring date-time

When the payment method was last updated. Format: YYYY-MM-DDTHH:mm:ss.SSSZ.

Example response

{
  "_id": "5f92cbf10cf217478ba93561",
  "accountId": "5f293ca69fa6bd01659b645e",
  "guestId": "5f293ca69fa6bd01659b645e",
  "paymentProviderId": "5fe4b21675087f01a3c5ab5b",
  "method": "STRIPE",
  "saveForFutureUse": true,
  "last4": "4242",
  "brand": "visa",
  "status": "ACTIVE",
  "type": "PHYSICAL",
  "confirmationCode": "GY-123456",
  "createdAt": "2026-10-01T12:00:00.000Z",
  "updatedAt": "2026-10-01T12:00:05.000Z"
}

Changes