APapaleo
PaymentAccount

Returns a single payment account by ID

<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/{id}

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/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: payment-accounts.read, payment-accounts.manage, admin

Path parameters

idstring required

The identifier of the payment account

Query parameters

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

idstring required

Payment account id

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

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

status'Pending' | 'Success' | 'Failure' | 'Canceled' | 'Expired' required

Status of the payment account

failureReasonstring nullable

Human-readable failure reason

payerInteraction'PciToken' | 'Terminal' | 'Authorization' | 'PaymentLink' required

Payer interaction of the payment account

isVirtualboolean

Indicates if the payment account is a virtual credit card. If not specified it defaults to 'false'

Example response

{
  "id": "QWERTYUI",
  "target": {
    "type": "Booking",
    "id": "ASDFGHJK"
  },
  "created": "2026-10-30T14:13:47.413387Z",
  "updated": "2026-10-30T15:13:47.4133883Z",
  "externalReference": {
    "paymentTransactionId": "VT6G6BFUR6XE5MHZARAX2ODK7Y"
  },
  "status": "Pending",
  "payerInteraction": "PaymentLink",
  "paymentLink": {
    "expiresAt": "2026-10-31T14:13:47.4133906Z",
    "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."
        }
      ]
    }
  ]
}

Changes

No operation changes recorded.