GUguesty
Payment Methods

Create payment method

Changed on

Vaults a payment method for a guest. Card details are not sent here. Send exactly one of _id or stripeCardToken.

Replaces the deprecated Add a payment method for a guest.

post/payment-methods

Request

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

Request body

guestIdstring required

Guesty guest id of the guest who owns the payment method

_idstring

Payment method id returned by GuestyPay tokenization. Send exactly one of _id or stripeCardToken.

paymentProviderIdstring required

Provider used when the card was tokenized

stripeCardTokenstring

Token returned by direct tokenization with Stripe (pm_… or tok_…), for Stripe providers only. Send exactly one of _id or stripeCardToken.

confirmationCodestring required

Booking confirmation code of the reservation this payment method is added for (for example GY-123456). It links the payment method to that reservation.

reuseboolean

Whether the payment method can be reused for other reservations belonging to the same guest

Example request

{
  "guestId": "5f293ca69fa6bd01659b645e",
  "_id": "5f92cbf10cf217478ba93561",
  "paymentProviderId": "5213a2d206112710005d96ff",
  "stripeCardToken": "pm_1N...",
  "confirmationCode": "GY-123456"
}

Response

The created 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