v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Collect payment for a class booking by using the guest's saved credit/debit card

This API helps you to collect payment for the class booking by using the guest's saved credit/debit card.

You must specify appropriate details for the parameters in the API request body. For more information, refer to the Request Body Parameters table.

post/Catalog/Payments/Invoice/IntializeCloudPayment

Query parameters

transactionDetailsobject

Object that contains various transaction-related elements. For more information, refer to the transactionDetails Object table.

billingInfoobject

Object that contains various billing-related elements. For more information, refer to the billingInfo Object table.

shippingInfoobject

Object that contains various shipping-related elements. For more information, refer to the shippingInfo Object table.

paymentDetailsobject

Object that contains various payment-related elements. For more information, refer to the paymentDetails Object table.

Response

200

InvoiceTransactionIdstring

PrintRecieptboolean

TransactionIdstring

RequireSignatureboolean

successboolean

{"stackTrail":"paths:/Catalog/Payments/Invoice/IntializeCloudPayment:post:responses:200:content:application/json:schema:properties:ToastMessage","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/Catalog/Payments/Invoice/IntializeCloudPayment:post:responses:200:content:application/json:schema:properties:Error","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/Catalog/Payments/Invoice/IntializeCloudPayment:post:responses:200:content:application/json:schema:properties:HostedPaymentURL","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/Catalog/Payments/Invoice/IntializeCloudPayment:post:responses:200:content:application/json:schema:properties:TokenFK","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/Catalog/Payments/Invoice/IntializeCloudPayment:post:responses:200:content:application/json:schema:properties:ProcessingMessage","oasType":"schema","type":"unknown"}

Example response

{
  "InvoiceTransactionId": "95cdc4fc-9697-45b2-ac47-7626a5d3b2c7",
  "TransactionId": "853600952732259G",
  "success": true
}