APapaleo
FolioPayments

Trigger a payment on a card terminal for the folio.

Trigger a terminal payment for the folio. 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'.

post/finance/v0-nsfw/folios/{folioId}/payments/by-terminal

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/by-terminal
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: folios.manage, admin

Path parameters

folioIdstring required

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

terminalIdstring required

Terminal to be used for the payment

askForTipboolean

When true, the terminal prompts for a tip. Defaults to false when omitted.

Example request

{
  "terminalId": "V400m-324689704",
  "askForTip": false,
  "amount": {
    "amount": 230,
    "currency": "EUR"
  },
  "paidCharges": [
    {
      "chargeId": "BLIPKWXP-1-1-1",
      "amount": 230
    }
  ]
}

Response

Payment was created and will be processed via the specified terminal.

idstring required

Changes

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