APapaleo
PaymentAccount

Creates payment account by using the terminal

Changed on

<br>You must have this scope: 'payment-accounts.manage'.<br>For fine-grained clients, you must have this permission: 'core.payment_accounts.create'.

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

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

propertyIdstring required

The id of the property which configuration (e.g. currency) is used to create payment account. For reservation payment accounts should match the reservation property.

terminalIdstring required

Terminal to be used for the payment account

Example request

{
  "target": {
    "type": "Booking",
    "id": "KYKXKLWL"
  },
  "propertyId": "MUC",
  "terminalId": "V400m-324689704"
}

Response

Created

idstring required

Created payment account id

Example response

{
  "id": "UBMFXUFH"
}

Changes