---
title: "Creates a link to a payment form that allows guests to complete the payment account"
method: POST
path: "/booking/v0-nsfw/payment-accounts/by-link"
tags: ["PaymentAccount"]
---

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

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

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

## Headers

- `Idempotency-Key` string

## Request body

- CreatePaymentLinkPaymentAccountRequest
  - `target` PaymentAccountTargetModel, required
    - `type` 'Booking' | 'Reservation', required: Payment account target type
    - `id` string, required: Booking or reservation id
  - `propertyId` string, 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.
  - `expiresAt` string, date-time, required: The date that the 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>
  - `countryCode` string, required: The payer's country code
  - `description` string, nullable: Payment account description. It will be shown on the payment form of the link
  - `payerEmail` string, 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
  - `returnUrl` string, nullable: Website URL used for redirection after payment is completed using the payment link.

## Response `201`

Created

- PaymentAccountCreatedModel
  - `id` string, required: Created payment account id

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `415`: Unsupported media type.
- `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)