APapaleo
FolioPayments

Get a payment by ID.

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

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

Path parameters

folioIdstring required
paymentIdstring required

The payment ID.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Success.

idstring 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

receiptstring nullable

Receipt for the payment

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

movedReasonstring nullable

A reason why the move operation was performed

sourcePaymentIdstring nullable

A link to the original payment in case of splitting payments

depositEntryIdstring nullable

Id of the deposit entry this payment was classified as, if any

status'Pending' | 'Success' | 'Failure' | 'Canceled' required

Status of the payment

failureReasonstring 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

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

descriptionstring nullable

Payment link description

urlstring nullable

Payment link url

businessDatestring date required

The business date of the payment

Example response

{
  "id": "C3Q890XZ",
  "method": "Cash",
  "amount": {
    "amount": 230,
    "currency": "EUR"
  },
  "externalReference": {
    "merchantReference": "BLIPKWXP-1",
    "pspReference": "8535063621298633"
  },
  "paymentDate": "0001-01-01T00:00:00Z",
  "status": "Success",
  "type": "Custom",
  "businessDate": "1845-01-12"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.