---
title: "Captures a specific amount from a pre-authorization and posts it to the folio."
method: POST
path: "/finance/v1/folios/{folioId}/payments/by-authorization"
tags: ["FolioPayments"]
---

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

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

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'.

## Path parameters

- `folioId` string, required

## Headers

- `Idempotency-Key` string

## Request body

- CreateAuthorizationPaymentRequest
  - `transactionReference` string, 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
  - `amount` MonetaryValueModel, required
    - `amount` number, double, required
    - `currency` string, required
  - `paidCharges` PaymentPaidChargesRequest[], nullable: List of charges and amount being covered by this payment.
    - `chargeId` string, required: The ID of the charge being paid
    - `amount` number, double, required: The amount being covered with the payment. If not provided it is assumed that the payment is covering the full amount of the charge

## Response `201`

Payment was created and will be processed.

- PaymentCreatedModel
  - `id` string, required

## 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-finance-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api/revisions/6f1d524c1ea7?raw)