Skip to main content

Convenient checkout API

Convenient Checkout API service provides a means of executing Restful requests without the use of the Convenient Checkout UI. In order to use any APIs related to Payments, it will require an existing PaymentMethodId in lieu of the card number due to PCI Compliance. Some use cases for APIs are:

  • Recurring payments
  • Capturing an authorized payment

API Architecture​

Snag_7d9c3aa1

• Azure Cloud, multi region.

• AKS Azure Kubernetes.

• Multi Cloud API Gateway.

• ISTIO - Ingress Controller.

• Splunk.

• Azure Postgres DB.

APIs​

In addition to the HCP API Catalog for the Financial Package: Commerce subpackage, the following APIs are offered as described by the process flows:

Merchant​

Snag_31def0ea

1. Create Session​

Create session for Initializing the convenient Checkout Widget. Returns a session ID

2. Load Embedded Widget​

Utilize the session ID returned from Create Session API (Step 1) to load the embedded widget and perform the desired payment option. This will return Merchant Transaction ID and Payment ID to track the transaction.

Get Payment Status​

A payment status can be retrieved in two ways.
3. Get Payment Status by Merchant Transaction ID Get status for payment using the Merchant Transaction ID returned by Widget in step 2

4. Get Payment Status by Payment ID Get status for payment using the Payment ID returned by Widget in step 2

Get Customer Payment Methods​

Gets all the payment method for a given existing customer

Create Payment​

Creates a payment request. The payment request may be attempted to be confirmed automatically by setting autoConfirm to true. Default is false

Capture Amount by Payment ID​

Creates a payment request. The payment request may be attempted to be confirmed automatically by setting autoConfirm to true. Default is false