APapaleo
FolioPayments

Creates a link to a payment form where guests can pay.

Creates a link to a payment form where guests can pay. To enable open invoice payment methods you need to provide at least the paid charges with the request. For some open invoice payment methods you also need to ensure that the full billing address of the folio is set, before you create the payment link. The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as a payment is pending it reduces the amount of allowed payments for the folio.<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.create'.

post/finance/v1/folios/{folioId}/payments/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/finance/v1/folios/{folioId}/payments/by-link
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: folios.manage, admin

Path parameters

folioIdstring required

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

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. Used to provide suitable for the payer payment methods and use default country language

descriptionstring nullable

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

payerEmailstring email 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

{
  "expiresAt": "2026-10-27T17:03:18.9396041Z",
  "countryCode": "de",
  "description": "Prepayment for the group booking apaleo Summer party",
  "payerEmail": "0chai@hemenal5.space",
  "returnUrl": "https://example.com/return",
  "amount": {
    "amount": 150,
    "currency": "EUR"
  },
  "paidCharges": [
    {
      "chargeId": "BLIPKWXP-1-1-1",
      "amount": 230
    }
  ]
}

Response

Payment was created and will be processed.

idstring required

Changes

No recorded changes to this operation across all 3 revisions of this API.