payments

Performs a payment on behalf of a resort as part of the <em>Easy Checkout</em> process

post/v0/payments/check_out

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/payments/check_out
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: pms)

Headers

authorizationstring

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Request body

customer_idstring

Clubmed id of the customer that have to pay this checkout.

booking_idstring

Booking id to which this payment is related.

amountnumber

Amount of the payment.

resort_idstring

4 letter codes of the resort requesting the payment.

preauthorize_onlyboolean

When set to true, perform a preauthorization only, otherwise an actual payment is performed.

Example request

{
  "customer_id": "142536789",
  "booking_id": "220209100",
  "resort_id": "SANC",
  "preauthorize_only": true,
  "payment_instrument": {
    "token": "145ab785cd"
  }
}

Response

  • technical ok
  • ok
idstring

Id of the payment, to be reused for a refund operation

status'FAILURE' | 'SUCCESS'

SUCCESS if the payment was effectively done, FAILURE otherwise

codestring

Error code from the PSP, for analisys purpose

messagestring

Error message from the PSP, may give an hint of the cause of the problem.

payment_methodstring

Codified value, looking like a bank card brand, required by accountant department.

Example response

{
  "id": "SANC-220209100-20220209151210",
  "status": "SUCCESS",
  "code": "113",
  "message": "Insufficient Funds",
  "payment_method": "VISA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.