---
title: "Returns a list of payment accounts based on the query parameters"
method: GET
path: "/booking/v0-nsfw/payment-accounts"
tags: ["PaymentAccount"]
---

# Returns a list of payment accounts based on the query parameters

`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`

<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'.

## Query parameters

- `paymentAccountIds` string[]
- `propertyIds` string[]
- `bookingIds` string[]
- `reservationIds` string[]
- `payerInteractions` string[]
- `status` string[]
- `targetTypes` string[]
- `dateField` 'Creation' | 'Modification'
- `from` string, date-time
- `to` string, date-time
- `paymentLinkUrls` string[]
- `pageNumber` integer
- `pageSize` integer
- `sort` string[]
- `expand` string[]

## Response `200`

Successfully returned payment account list

- PaymentAccountV2ListModel
  - `paymentAccounts` PaymentAccountV2Model[], required: List of payment accounts
    - `id` string, required: Payment account id
    - `target` PaymentAccountTargetModel, required
      - `type` 'Booking' | 'Reservation', required: Payment account target type
      - `id` string, required: Booking or reservation id
    - `created` string, date-time, required: Date of creation<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>
    - `updated` string, date-time, required: Date of last modification<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>
    - `externalReference` ExternalPaymentAccountReferenceModel
      - `paymentTransactionId` string, required: Identifies the payment authorization in the Payment Transaction API
    - `status` 'Pending' | 'Success' | 'Failure' | 'Canceled' | 'Expired', required: Status of the payment account
    - `failureReason` string, nullable: Human-readable failure reason
    - `payerInteraction` 'PciToken' | 'Terminal' | 'Authorization' | 'PaymentLink', required: Payer interaction of the payment account
    - `paymentLink` PaymentAccountPaymentLinkModel
      - `expiresAt` string, date-time: The date and time the payment link expires<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>
      - `url` string, nullable: The URL to the payment link
    - `accountDetails` PaymentAccountDetailsModel
      - `accountNumber` string, nullable: The last 4 characters of the card or account number
      - `accountHolder` string, nullable: The account or card holder
      - `expiryMonth` string, nullable: The credit card's expiration month
      - `expiryYear` string, nullable: The credit card's expiration year
      - `paymentMethod` string, nullable: The payment method (e.g. visa)
      - `payerEmail` string, email, nullable: The email address of the shopper / customer
    - `isVirtual` boolean: Indicates if the payment account is a virtual credit card. If not specified it defaults to 'false'
    - `actions` ActionModelPaymentAccountActionNotAllowedPaymentAccountActionReason[], nullable: The list of actions for payment account
      - `action` 'Cancel' | 'ExpirePaymentLink', required
      - `isAllowed` boolean, required
      - `reasons` ActionReasonModelNotAllowedPaymentAccountActionReason[], nullable
        - `code` 'OnlySuccessfulPaymentAccountCanBeCanceled' | 'OnlyPendingPaymentLinkPaymentAccountCanBeExpired', required
        - `message` string, required
  - `count` integer, required: Total count of items

## Other responses

- `204`: No payment accounts found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-booking-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-booking-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-booking-api-not-safe-for-work/revisions/a1b6a2f6b879?raw)