---
title: "Get a payment by ID."
method: GET
path: "/finance/v1/folios/{folioId}/payments/{paymentId}"
tags: ["FolioPayments"]
---

# Get a payment by ID.

`GET /finance/v1/folios/{folioId}/payments/{paymentId}`

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

Get a payment by its ID<br>You must have at least one of these scopes: 'folios.read, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.read'.

## Path parameters

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

## Query parameters

- `expand` string[]

## Response `200`

Success.

- FolioPaymentModel
  - `id` string, required: Id of the payment. This is unique within one folio
  - `method` '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', nullable: The payment method
  - `amount` MonetaryValueModel, required
    - `amount` number, double, required
    - `currency` string, required
  - `externalReference` ExternalReference
    - `merchantReference` string, required: The merchant reference ('order number')
    - `pspReference` string, required: The globally unique identifier of this payment in the reports of the payment service
  - `receipt` string, nullable: Receipt for the payment
  - `paymentDate` string, date-time, required: The date and time when the payment was created<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>
  - `movedFrom` EmbeddedFolioModel
    - `id` string, required: Folio ID
    - `debitor` string, nullable: Name of the debitor - the one who will pay the bill
  - `movedTo` EmbeddedFolioModel
    - `id` string, required: Folio ID
    - `debitor` string, nullable: Name of the debitor - the one who will pay the bill
  - `movedReason` string, nullable: A reason why the move operation was performed
  - `sourcePaymentId` string, nullable: A link to the original payment in case of splitting payments
  - `depositEntryId` string, nullable: Id of the deposit entry this payment was classified as, if any
  - `status` 'Pending' | 'Success' | 'Failure' | 'Canceled', required: Status of the payment
  - `failureReason` string, nullable: Human readable failure reason
  - `failureCode` 'Failed' | 'TimedOut', nullable: Machine-readable failure code
  - `type` 'Custom' | 'Terminal' | 'PaymentAccount' | 'Authorization' | 'PaymentLink' | 'PreAuthorization', required: Type of the payment
  - `expiresAt` string, date-time, nullable: The date and time a payment 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>
  - `description` string, nullable: Payment link description
  - `url` string, nullable: Payment link url
  - `actions` ActionModelPaymentActionNotAllowedPaymentActionReason[], nullable: The list of actions for this payment
    - `action` 'Cancel' | 'OnlineRefund' | 'ManualRefund' | 'FullOnlineRefund', required
    - `isAllowed` boolean, required
    - `reasons` ActionReasonModelNotAllowedPaymentActionReason[], nullable
      - `code` 'CancelNotAllowedForPaymentNotInStatusPending' | 'CancelNotAllowedForPaymentNotOfPaymentLinkType' | 'OnlineRefundNotAllowedForRestrictedPaymentMethodOrAcquirer' | 'ManualRefundNotAllowedWhenOnlineRefundIsPossible' | 'CancelNotAllowedForIncompletePaymentLink', required
      - `message` string, required
  - `businessDate` string, date, required: The business date of the payment

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `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)