APapaleo
PaymentAccount

Creates payment account by using a PCI proxy credit card token

<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/v0-nsfw/payment-accounts/by-pci-credit-card-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-credit-card-token
  • 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.

tokenType'PciProxy' | 'Payrails' required

The type of the token and the token provider

creditCardTokenstring required

PCI credit card token to be used to authorize the payment account

cvcTokenstring nullable

PCI CVC token 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

isVirtualboolean

Indicates if the payment account is a virtual credit card

retryWithoutCvcOnCvcErrorboolean

Retry payment account creation without CVC if cvc error happened. Retry happens only if CvcToken is passed.

Example request

{
  "target": {
    "type": "Booking",
    "id": "KYKXKLWL"
  },
  "propertyId": "MUC",
  "tokenType": "PciProxy",
  "creditCardToken": "411111GGCMUJ1111",
  "cvcToken": "1t28whJOQBSlqhUX26QjYjSO",
  "payerEmail": "mr.king@test.com",
  "cardHolder": "Douglas King",
  "expiryMonth": "03",
  "expiryYear": "2030",
  "isVirtual": false,
  "retryWithoutCvcOnCvcError": false
}

Response

Created

idstring required

Created payment account id

Example response

{
  "id": "UBMFXUFH"
}

Changes

No operation changes recorded.