Skip to main content
API docs by Redocly

Convenient Checkout Api (v1)

Download OpenAPI specification:Download

CCGLeads: CCGLeads@ds.uhc.com Terms of Service

Convenient Checkout Gateway API

payment-controller

Get Payment Status by Merchant Transaction Id

Authorizations:
gateway
query Parameters
merchantTransactionId
required
string <uuid>
header Parameters
X-Merchant-Id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

Create Payment

Authorizations:
gateway
header Parameters
X-Merchant-Id
required
string <uuid>
X-Customer-Id
string
X-Checkout-Id
string <uuid>
Request Body schema: application/json
required
amount
required
integer <int64>
object (CustomerDetail)
object
paymentType
string
Deprecated
Enum: "PRE_AUTH" "SALE"
authorizeCard
boolean
Default: false

When authorizeCard is set as true, the credit card will be authorized for the amount supplied. Later we need to call the Capture API to complete the transaction. The authorization is valid only for 7 days. Applicable payment method types = [CARD]

partialAuthorization
boolean
Default: false

When true, card issuers will consider the payment for partial authorization. This flag shall be provided in combination with authorizeCard flag. Applicable payment method types = [CARD]

paymentMethodId
string <uuid>
paymentDescription
string
merchantTransactionId
string
object (Consent)
authRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "customer": {
    },
  • "metaData": {
    },
  • "paymentType": "PRE_AUTH",
  • "authorizeCard": false,
  • "partialAuthorization": false,
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "paymentDescription": "string",
  • "merchantTransactionId": "string",
  • "consent": {
    },
  • "authRequired": true
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

Get Payment Status by PaymentId

Authorizations:
gateway
path Parameters
paymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

DRAFT - Capture partial or full amount in Auth operations by PaymentId

Authorizations:
gateway
path Parameters
paymentId
required
string <uuid>
header Parameters
X-Merchant-Id
required
string <uuid>
Request Body schema: application/json
amount
integer <int64>
object

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

DRAFT - Cancel Payment by PaymentId

Authorizations:
gateway
path Parameters
paymentId
required
string <uuid>
header Parameters
X-Merchant-Id
required
string <uuid>
Request Body schema: application/json
paymentCancellationReason
required
string
Enum: "DUPLICATE" "FRAUDULENT" "REQUESTED_BY_CUSTOMER" "ABANDONED"
paymentCancellationMessage
string

Responses

Request samples

Content type
application/json
{
  • "paymentCancellationReason": "DUPLICATE",
  • "paymentCancellationMessage": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

auth-controller

Create session for initializing the convenient checkout widget

Authorizations:
gateway
header Parameters
X-Merchant-Id
required
string <uuid>
Request Body schema: application/json
required
object (PaymentDetail)
object (CustomerDetail)
object (Consent)

Responses

Request samples

Content type
application/json
{
  • "payment": {
    },
  • "customer": {
    },
  • "consent": {
    }
}

Response samples

Content type
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

DRAFT - Create Checkout Session

Authorizations:
gateway
header Parameters
X-Merchant-Id
required
string <uuid>
X-Customer-Id
string
Request Body schema: application/json
required
amount
integer <int64>
object
paymentType
required
string
Enum: "PRE_AUTH" "SALE" "REFUND" "REVERSAL"
merchantTransactionId
string
statementDescriptorSuffix
string <= 10 characters ^(?=.*[a-zA-Z])[a-zA-Z0-9 \-.]{0,10}$|^$

Suffix to be added to the statement descriptor

paymentDescription
string <= 100 characters

Payment description

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "metadata": {
    },
  • "paymentType": "PRE_AUTH",
  • "merchantTransactionId": "string",
  • "statementDescriptorSuffix": "Chan FAIR",
  • "paymentDescription": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": { }
}

getCheckoutStatus

Authorizations:
gateway
path Parameters
checkoutId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": { }
}

payment-method-controller

DRAFT - Find payment-methods for customer

Authorizations:
gateway
header Parameters
X-Merchant-Id
required
string <uuid>
Request Body schema: application/json
required
hsid
string
name
string
email
required
string
object
dateOfBirth
string <date>
object
ssnLastFour
string

Responses

Request samples

Content type
application/json
{
  • "hsid": "string",
  • "name": "string",
  • "email": "string",
  • "metadata": {
    },
  • "dateOfBirth": "2000-01-30",
  • "phoneNumber": {
    },
  • "ssnLastFour": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

getPaymentMethods

Authorizations:
gateway
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getPaymentMethod

Authorizations:
gateway
path Parameters
id
required
string <uuid>
payment-method-id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

updatePaymentMethod

Authorizations:
gateway
path Parameters
id
required
string <uuid>
payment-method-id
required
string <uuid>
Request Body schema: application/json
required
default
boolean
isDefault
boolean
expiryYear
integer <int32>
nameOnCard
string
expiryMonth
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "isDefault": true,
  • "expiryYear": 0,
  • "nameOnCard": "string",
  • "expiryMonth": 0
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

deletePaymentMethod

Authorizations:
gateway
path Parameters
id
required
string <uuid>
payment-method-id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "card": {
    },
  • "status": "INITIATED",
  • "vendor": "STRIPE",
  • "default": true,
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "paymentMethodType": "CARD",
  • "vendorPaymentMethodId": "string"
}

setup-payment-method-controller

createSetupPaymentMethod

Authorizations:
gateway
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
paymentMethodType
string
Enum: "CARD" "BANK_ACCOUNT"

Responses

Request samples

Content type
application/json
{
  • "paymentMethodType": "CARD"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}

getSetupPaymentMethodById

Authorizations:
gateway
path Parameters
id
required
string <uuid>
setup-payment-method-id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "data": {
    }
}