payments

Generates a payment link

post/v0/payments/link

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/payments/link
  • 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

Attendee customer identifier

booking_idstring

Booking identifier

first_namestring required

Customer first name

last_namestring required

Customer last name

expiration_date_timestring date required

Link expiration date

emailstring required

Customer email

phonestring required

Phone number

channel'EMAIL' | 'SMS' required

Specifies the communication channel used to send the generated payment link to the customer

amountnumber required

Payment amount

product_idstring required

Club Med product unique id

Example request

{
  "customer_id": "142536789",
  "booking_id": "220209100",
  "first_name": "Jean",
  "last_name": "Dupont",
  "expiration_date_time": "2022-04-15T10:23:00.234Z",
  "email": "email@test.com",
  "channel": "EMAIL",
  "amount": 148.56,
  "product_id": "SANC"
}

Response

ok

urlstring required

URL used to process remote payments

methodstring required

Payment redirect method

payment_idstring required

Payment id

Example response

{
  "url": "https://www.pspUrl.com",
  "method": "POST",
  "payment_id": "BU-340-R-137667"
}

Changes

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