Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Payment Account → GET payment accounts

AI-generated

Overview

This node operation retrieves payment account information from the Apaleo API. It supports filtering and sorting of payment accounts based on various criteria such as payment account IDs, property IDs, booking IDs, reservation IDs, payer interactions, status, target types, date fields, and payment link URLs. It also supports pagination and expanding embedded resources in the response. This operation is useful for scenarios where you need to fetch detailed payment account data for financial reconciliation, reporting, or integration with other systems.

Use Case Examples

  1. Fetch all payment accounts with status 'Success' and filter by specific booking IDs.
  2. Retrieve payment accounts created within a specific date range and sorted by creation date descending.
  3. Get payment accounts with expanded actions to see related embedded resources.

Properties

Name Meaning
Expand List of embedded resources that should be expanded in the response, e.g., actions.
Additional Fields Additional filtering and pagination options for retrieving payment accounts.

Output

JSON

  • paymentAccounts - Array of payment account objects retrieved from the API, containing details about each payment account.

Dependencies

  • Apaleo API access token credential

Troubleshooting

  • Common issues include invalid or expired API access tokens, resulting in authentication errors. Ensure the API credentials are correctly configured and valid.
  • Incorrect filter values or unsupported combinations may result in empty responses or API errors. Verify filter parameters before execution.
  • Pagination parameters exceeding limits (e.g., page size over 500) may cause errors. Adhere to the specified limits.

Links

Discussion