APapaleo
PaymentAccountActions

Sets payment account to failed

<br>You must have this scope: 'payments.admin'.<br>For fine-grained clients, you must have this permission: 'core.payment_accounts.fail'.

put/booking/v0-nsfw/payment-account-actions/{paymentAccountId}/fail

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-account-actions/{paymentAccountId}/fail
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: payments.admin, admin

Path parameters

paymentAccountIdstring required

The identifier of the payment account

Request body

paymentTransactionIdstring nullable

Transaction Id of payment account in the payment service payment transaction log

failureReasonstring nullable

Textual description of the failure reason.

Example request

{
  "paymentTransactionId": "VT6G6BFUR6XE5MHZARAX2ODK7Y",
  "accountDetails": {
    "accountNumber": "1111",
    "accountHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com"
  },
  "failureReason": "Card is expired"
}

Response

No Content

Changes

No operation changes recorded.