APapaleo
FolioPayments

Captures a specific amount from a pre-authorization and posts it to the folio.

Captures a specific amount from a pre-authorization and posts it to the folio. For the pre-authorization please ensure to set the respective metadata in the original payment transaction. The flow type has to be set to <i>CaptureOnly</i>. For more information please refer to the documentation of <a href="https://apaleo.dev/guides/business-cases/ibe/get-the-money" target="_blank">how to do a pre-authorization on a booking engine</a>. 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. The payment times out after 60 minutes automatically<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-authorization

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-authorization
  • 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

transactionReferencestring required

Reference to the original authorization transaction

referenceType'PspReference' | 'AuthorizationId'

Type of TransactionReference used, default is PspReference When capturing a Consumption or Damage authorization, use AuthorizationId

Example request

{
  "transactionReference": "564578124534890J",
  "referenceType": "PspReference",
  "amount": {
    "amount": 330,
    "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.