Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Payment Transactions

Get payouts reconciliation data from Guesty Pay providers

  Retrieves payouts reconciliation reports from for Guesty Pay providers.
  Supports filtering by:
    - date range (startDate and endDate)
    - payoutId
    - subAccountId
    - reservation confirmation code (mutually exclusive with all other filters)

  Date range is mandatory unless reservationConfirmationCode is provided.
get/payment-transactions/reports/payouts-reconciliation

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.

payoutIdstring
Example:1999001136945796604

Filter results by payout id.

Response

List of payouts reconciliation entries

payoutIdstring required

Payout identifier.

payoutProcessDatestring required

Payout processing date.

payoutRejectOrReturnDatestring

Payout reject or return date.

payoutNamestring

Name of the payout.

payoutDescriptorstring

Descriptor associated with the payout.

payoutMethodstring

Payout method (e.g., ACH).

payoutAmountstring required

Payout amount represented as a string.

payoutStatusstring required

Payout status.

payoutAuthorizationOrErrorCodestring

Authorization or error code associated with the payout.

payoutProcessorstring

Processor handling the payout.

activityTypestring

Type of payout activity.

settlementDatestring

Settlement date for the payout.

transactionIdstring

Related transaction identifier.

merchantTransactionIdstring

Merchant transaction identifier associated with the payout.

processorTransactionIdstring

Processor transaction identifier associated with the payout.

transactionSystemDatestring

System date of the transaction.

transactionMerchantDatestring

Merchant date of the transaction.

transactionProcessorDatestring

Processor date of the transaction.

transactionTypestring

Transaction type.

paymentTypestring

Transaction payment type.

transactionPaymentMethodstring

Payment method associated with the transaction.

transactionAmountstring

Transaction amount.

transactionProcessorstring

Transaction processor name.

feeNamestring

Fee name.

feeGroupNamestring

Fee group name.

feeTypestring

Fee type.

feeCategorystring

Fee category.

feeAmountstring

Fee amount.

feeSourcestring

Fee source.

feeTargetstring

Fee target.

reserveCollectionDatestring

Reserve collection date.

reserveReleaseDatestring

Reserve release date.

reserveReleaseTypestring

Reserve release type.

reserveReleaseAmountstring

Reserve release amount.

adjustmentIdstring

Adjustment identifier.

adjustmentDatestring

Adjustment date.

adjustmentCategorystring

Adjustment category.

adjustmentTypestring

Adjustment type.

adjustmentNamestring

Adjustment name.

adjustmentPaymentMethodstring

Adjustment payment method.

adjustmentStatusstring

Adjustment status.

payoutValuestring

Payout value.

percentageLimitstring

Percentage limit.

percentageLimitAdjustmentValuestring

Percentage limit adjustment value.

amountLimitstring

Amount limit.

amountLimitAdjustmentValuestring

Amount limit adjustment value.

activeLimitstring

Active limit.

adjustmentAmountstring

Adjustment amount.

activityAmountstring

Activity amount.

currencystring required

Currency associated with the payout or transaction.

subAccountstring required

Sub account associated with the payout or transaction.

platformAccountstring required

Platform account associated with the payout or transaction.

Example response

[
  {
    "payoutAmount": "100.00"
  }
]