APapaleo
PaymentAccount

Returns a list of payment accounts based on the query parameters

<br>You must have at least one of these scopes: 'payment-accounts.read, payment-accounts.manage'.<br>For fine-grained clients, you must have this permission: 'core.payment_accounts.read'.

get/booking/v0-nsfw/payment-accounts

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/booking/v0-nsfw/payment-accounts
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: payment-accounts.read, payment-accounts.manage, admin

Query parameters

paymentAccountIdsstring[]

Filter result by requested payment account Ids

propertyIdsstring[]

Filter result by requested properties

bookingIdsstring[]

Filter result by requested booking ids. Returns payment accounts that are related to the specified booking or booking reservations. Use in combination with the Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.TargetTypes to get payment accounts related only to bookings or to reservations.

reservationIdsstring[]

Filter result by requested reservation ids

payerInteractionsstring[]

Filter result by payment account payer interactions

statusstring[]

Filter result by payment account status

targetTypesstring[]

Filter by target types

dateField'Creation' | 'Modification'

Filter result by date and time attributes of payment account. Use in combination with the Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.From and Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.To attributes. All filters will check if the date specified by the filter type is between Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.From (included) and Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.To (excluded).

fromstring date-time

The start of the time interval. When filtering by Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.DateField, at least one of Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.From and Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.To has to be specified<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time

The end of the time interval, must be larger than Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.From. When filtering by Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.DateField, at least one of Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.From and Apaleo.Api.Modules.Booking.Models.PaymentAccountV2.PaymentAccountV2ListRequest.To has to be specified<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

paymentLinkUrlsstring[]

Filter by payment link urls

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

sortstring[]

List of all fields that can be used to sort the results. Possible values are: created:asc, created:desc, updated:asc, updated:desc, expiresat:asc, expiresat:desc. All other values will be silently ignored.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Successfully returned payment account list

countinteger required

Total count of items

Example response

{
  "paymentAccounts": [
    {
      "id": "QWERTYUI",
      "target": {
        "type": "Booking",
        "id": "ASDFGHJK"
      },
      "created": "2026-10-30T14:13:47.4184664Z",
      "updated": "2026-10-30T15:13:47.4184666Z",
      "externalReference": {
        "paymentTransactionId": "VT6G6BFUR6XE5MHZARAX2ODK7Y"
      },
      "status": "Pending",
      "payerInteraction": "PaymentLink",
      "paymentLink": {
        "expiresAt": "2026-10-31T14:13:47.4184668Z",
        "url": "https://test.adyen.link/PL0E1BC57CAEE63F2F0"
      },
      "accountDetails": {
        "accountNumber": "1111",
        "accountHolder": "John Doe",
        "expiryMonth": "8",
        "expiryYear": "2018",
        "paymentMethod": "visa",
        "payerEmail": "s.hopper@test.com"
      },
      "isVirtual": false,
      "actions": [
        {
          "action": "Cancel",
          "isAllowed": false,
          "reasons": [
            {
              "code": "OnlySuccessfulPaymentAccountCanBeCanceled",
              "message": "Only a successful payment account can be canceled."
            }
          ]
        }
      ]
    }
  ],
  "count": 1
}

Changes

No operation changes recorded.