---
title: "Trigger a custom payment for the folio."
method: POST
path: "/finance/v0-nsfw/folios/{folioId}/payments"
tags: ["FolioPayments"]
---

# Trigger a custom payment for the folio.

`POST /finance/v0-nsfw/folios/{folioId}/payments`

## 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/v0-nsfw/folios/{folioId}/payments`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `folios.manage`, `admin`

A custom payment will not involve any automatic processing. This is best to be used for cash, cheque or voucher payments or payments that have
been processed by an external system and it should just be recorded in apaleo for accounting purposes.<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

- CreateCustomPaymentRequest
  - `method` 'Cash' | 'BankTransfer' | 'CreditCard' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'Representation' | 'IDeal', required: The payment method. Use 'CreditCard', if none of the specific credit cards types matches. 'Booking.com' only makes sense, if the property (hotel) configured Booking.com > Finance to be 'Payments by Booking.com'
  - `receipt` string, nullable: The optional receipt you want to store for the payment. It defaults to the reservation or external folio id. This field is required if you are adding payment to the house account
  - `businessDate` string, date, nullable: The business date of the payment. Defaults to the current date. In some cases you might want to post the payments to the previous business date, this is only possible until 6 AM of the current day.
  - `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 accounting was performed.

- 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-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/revisions/72cbd31f02f4?raw)