APapaleo
PaymentAccount

Creates a link to a payment form that allows guests to complete the payment account

Changed on

<br>You must have this scope: 'payment-accounts.manage'.<br>For fine-grained clients, you must have this permission: 'core.payment_accounts.create'.

post/booking/v1/payment-accounts/by-link

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

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

propertyIdstring required

The id of the property which configuration (e.g. currency) is used to create payment account. For reservation payment accounts should match the reservation property.

expiresAtstring date-time required

The date that the link expires<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

countryCodestring required

The payer's country code

descriptionstring nullable

Payment account description. It will be shown on the payment form of the link

payerEmailstring nullable

The email address of the payer or cardholder. It can be used to verify the identity of the payer and allow to catch a fraudulent usage of the payment account if the email address does not match the one on file at the bank

returnUrlstring nullable

Website URL used for redirection after payment is completed using the payment link.

Example request

{
  "target": {
    "type": "Booking",
    "id": "KYKXKLWL"
  },
  "propertyId": "MUC",
  "expiresAt": "2026-10-18T03:03:14.5483351Z",
  "countryCode": "DE",
  "description": "Payment information for the booking",
  "payerEmail": "user@email.com",
  "returnUrl": "https://example.com/return"
}

Response

Created

idstring required

Created payment account id

Example response

{
  "id": "UBMFXUFH"
}

Changes