APapaleo
PaymentAccount

Creates payment account based on an existing authorization created prior externally with the Payment Service Provider

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-stored-payment-method

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-stored-payment-method
  • 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

payerReferencestring required

Reference to uniquely identify the payer

storedPaymentMethodIdstring required

Reference to uniquely identify the stored recurring authorization, or LATEST to use the latest stored payment method for the given payerReference

isVirtualboolean

Indicates if the payment account is a virtual credit card

Example request

{
  "target": {
    "type": "Booking",
    "id": "KYKXKLWL"
  },
  "payerReference": "4c5b0e9d-819e-481f-bc32-85068267e641",
  "storedPaymentMethodId": "K9DTTJQD4HNG5S82",
  "isVirtual": false,
  "accountDetails": {
    "accountNumber": "1111",
    "accountHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "john@example.com"
  }
}

Response

Created

idstring required

Created payment account id

Example response

{
  "id": "UBMFXUFH"
}

Changes