---
title: "Set a payment to success."
method: PUT
path: "/finance/v0-nsfw/folios/{folioId}/payments/{paymentId}/commit"
tags: ["FolioPayments"]
---

# Set a payment to success.

`PUT /finance/v0-nsfw/folios/{folioId}/payments/{paymentId}/commit`

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

Sets a payment to success and triggers the accounting. This API can also be called on failed or timed out payments<br>You must have this scope: 'payments.admin'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.commit'.

## Path parameters

- `folioId` string, required
- `paymentId` string, required

## Request body

- CommitPaymentModel
  - `pspReference` string, required: The id of the payment from the payment service provider
  - `paymentMethod` 'Cash' | 'BankTransfer' | 'CreditCard' | 'Invoice' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'PspCash' | 'PspDebit' | 'PspBanking' | 'PspOpenInvoice' | 'PspWallet' | 'Representation' | 'IDeal', required: Payment method this payment was processed with
  - `refundActionAllowed` 'None' | 'Online' | 'Manual' | 'OnlyFull', nullable
  - `capturedAmount` MonetaryValueModel
    - `amount` number, double, required
    - `currency` string, required

## Response `204`

Success

## 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)