v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Payment Transactions

Get transactions from Guesty Pay providers

  The endpoint retrieves transaction data from Guesty Pay providers
  The endpoint supports filtering by:
    - date range (startDate and endDate)
    - reservation confirmation code
    - subAccountId
  However, you can not use the reservationConfirmationCode filter together with other filters.

  The date range filter is mandatory if you do not use the reservationConfirmationCode filter.

get/payment-transactions/reports

Query parameters

startDatestring

Example:2025-01-01

Start date filter.

endDatestring

Example:2025-01-31

End date filter.

subAccountIdstring

Example:1234.1

Return data for a specific sub account. The format should be accountId.subAccountId.

reservationConfirmationCodestring

Example:GY-Yqjs4JT2

Reservation confirmation code. This filter cannot be used together with other filters.

skipnumber

Entries to skip.

takenumber

Example:25

Entries to take.

Response

The list of transactions

transactionIdstring required

Unique identifier for this transaction from the payment processor.

reservationConfirmationCodestring required

Guesty reservation confirmation code.

amountstring required

Transaction amount in decimal format.

currencystring required

ISO currency code of the transaction.

last4string required

Last four digits of the card used in the transaction.

merchantDatestring required

Transaction processing date and time by the merchant.

binstring

Bank identification number (BIN) of the card.

subAccountstring

Payment processor account identifier - merchant account name.

systemDatestring

Transaction processing date and time.

settlementDatestring

Transaction settlement date and time.

paymentMethodstring

Payment method type/brand.

processorARNstring

Acquirer reference number returned by the processor.

dynamicDescriptorstring

Dynamic descriptor sent to the processor.

statusstring

Transaction status.

transactionTypestring

Type of the transaction.

authorizationOrErrorCodestring

Authorization code or error code returned by the processor.