PaymentAccount

Creates payment account by using a PCI proxy transaction ID token

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

post/booking/v0-nsfw/payment-accounts/by-pci-transaction-id-token

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/v0-nsfw/payment-accounts/by-pci-transaction-id-token
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: captcha-protection

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.

Apaleo-Captcha-Tokenstring

Captcha token value, must be valid and can only be used once

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.

transactionIdstring required

Pci Transaction Id to be used to authorize the payment account

payerEmailstring email nullable

The payer e-mail address

cardHolderstring required

The credit card holder name

expiryMonthstring required

The credit card expiry month

expiryYearstring required

The credit card expiry year

Example request

{
  "target": {
    "type": "Booking",
    "id": "KYKXKLWL"
  },
  "propertyId": "MUC",
  "transactionId": "411111967831111885",
  "payerEmail": "mr.king@test.com",
  "cardHolder": "Douglas King",
  "expiryMonth": "03",
  "expiryYear": "2030"
}

Response

Created

idstring required

Created payment account id

Example response

{
  "id": "UBMFXUFH"
}

Changes

No operation changes recorded.