Convenient Checkout Api (v1)

Download OpenAPI specification:Download

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

Convenient Checkout Gateway API - Prod

Internal

Create Checkout Session

Authorizations:

gateway

header Parameters

X-Merchant-Id

required

string <uuid>

Request Body schema: application/json
required

paymentType	string Enum: "PRE_AUTH" "SALE"
authorizeCard	boolean
merchantTransactionId	string
paymentDescription	string
statementDescriptorSuffix	string
amount	integer <int64>
	object
	object (CheckoutSessionConfig)

Responses

Request samples

Payload

Content type

application/json

{"paymentType": "PRE_AUTH",
"authorizeCard": true,
"merchantTransactionId": "string",
"paymentDescription": "string",
"statementDescriptorSuffix": "string",
"amount": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"config": {"modes": ["PAYMENT"
],
"paymentMethodChannel": {"card": ["TERMINAL"
],
"bankAccount": ["WEBFORM"
]
},
"privacyPolicyUrl": "string",
"senderEmailAddress": "string"
}
}

Response samples

200
202
400
406
500

Content type

application/json

{"url": "string",
"data": {"checkoutSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"checkoutRequest": {"paymentType": "PRE_AUTH",
"authorizeCard": true,
"partialAuthorization": false,
"agent": {"firstName": "string",
"lastName": "string",
"isAccessVerified": true,
"userId": "string"
},
"merchantTransactionId": "string",
"paymentDescription": "string",
"statementDescriptorSuffix": "string",
"email": "string",
"phoneNumber": "string",
"amount": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"config": {"modes": ["PAYMENT"
],
"paymentMethod": [{"type": "CARD",
"channels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
}
],
"paymentMethodChannel": {"card": ["TERMINAL"
],
"cardChannels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
},
"privacyPolicyUrl": "string",
"senderEmailAddress": "string"
}
},
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"checkoutSessionStatus": "CREATED",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"vendorMerchantId": "string",
"paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"childSessionId": "8c886e65-64c0-43e1-a5fe-fb08ca7d983b",
"appearance": {"font": {"fontFamily": "string",
"fontSources": [{"cssSrc": "string",
"family": "string",
"src": "string",
"style": "string",
"weight": "string"
}
]
},
"pallete": {"primary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
},
"secondary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
}
}
},
"paymentMethod": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"zipCode": "string"
},
"default": true,
"paymentMethodType": "CARD",
"nickname": "string",
"error": null,
"status": "COMPLETED",
"paymentMethodDetails": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
}
},
"childSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "NOTIFICATION_CREATED",
"mode": "TEXT_TO_ADD",
"error": null,
"createdAt": "string",
"expiresAt": "string",
"notification": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"channel": "TEXT",
"destination": ["+11111111111"
]
}
}
},
"hcpToken": "****"
}
}

Create Child CheckOut Session

Authorizations:

gateway

path Parameters

sessionId

required

string

parent session Id

header Parameters

X-Merchant-Id

required

string <uuid>

Request Body schema: application/json
required

email	string
	object (PhoneNumber)
childSessionMode	string Enum: "TEXT_TO_ADD" "EMAIL_TO_ADD" "TEXT_TO_PAY" "EMAIL_TO_PAY"

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/checkout-sessions/{sessionId}/child-sessions

stage CCG Api Server

https://stg-wallet.healthsafepay.com/checkout-sessions/{sessionId}/child-sessions

test CCG Api Server

https://test-wallet.healthsafepay.com/checkout-sessions/{sessionId}/child-sessions

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/checkout-sessions/{sessionId}/child-sessions

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": {"countryCode": "string",
"number": "string"
},
"childSessionMode": "TEXT_TO_ADD"
}

Response samples

200
202
400
406
500

Content type

application/json

{"url": "string",
"data": {"checkoutSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"checkoutRequest": {"paymentType": "PRE_AUTH",
"authorizeCard": true,
"partialAuthorization": false,
"agent": {"firstName": "string",
"lastName": "string",
"isAccessVerified": true,
"userId": "string"
},
"merchantTransactionId": "string",
"paymentDescription": "string",
"statementDescriptorSuffix": "string",
"email": "string",
"phoneNumber": "string",
"amount": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"config": {"modes": ["PAYMENT"
],
"paymentMethod": [{"type": "CARD",
"channels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
}
],
"paymentMethodChannel": {"card": ["TERMINAL"
],
"cardChannels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
},
"privacyPolicyUrl": "string",
"senderEmailAddress": "string"
}
},
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"checkoutSessionStatus": "CREATED",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"vendorMerchantId": "string",
"paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"childSessionId": "8c886e65-64c0-43e1-a5fe-fb08ca7d983b",
"appearance": {"font": {"fontFamily": "string",
"fontSources": [{"cssSrc": "string",
"family": "string",
"src": "string",
"style": "string",
"weight": "string"
}
]
},
"pallete": {"primary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
},
"secondary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
}
}
},
"paymentMethod": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"zipCode": "string"
},
"default": true,
"paymentMethodType": "CARD",
"nickname": "string",
"error": null,
"status": "COMPLETED",
"paymentMethodDetails": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
}
},
"childSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "NOTIFICATION_CREATED",
"mode": "TEXT_TO_ADD",
"error": null,
"createdAt": "string",
"expiresAt": "string",
"notification": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"channel": "TEXT",
"destination": ["+11111111111"
]
}
}
},
"hcpToken": "****"
}
}

Get CheckOut Session

Authorizations:

gateway

path Parameters

sessionId

required

string

sessionId

query Parameters

init	boolean if true, appearance object will be returned, else apperance object is null

Responses

Response samples

Content type

application/json

{"url": "string",
"data": {"checkoutSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"checkoutRequest": {"paymentType": "PRE_AUTH",
"authorizeCard": true,
"partialAuthorization": false,
"agent": {"firstName": "string",
"lastName": "string",
"isAccessVerified": true,
"userId": "string"
},
"merchantTransactionId": "string",
"paymentDescription": "string",
"statementDescriptorSuffix": "string",
"email": "string",
"phoneNumber": "string",
"amount": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"config": {"modes": ["PAYMENT"
],
"paymentMethod": [{"type": "CARD",
"channels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
}
],
"paymentMethodChannel": {"card": ["TERMINAL"
],
"cardChannels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
},
"privacyPolicyUrl": "string",
"senderEmailAddress": "string"
}
},
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"checkoutSessionStatus": "CREATED",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"vendorMerchantId": "string",
"paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"childSessionId": "8c886e65-64c0-43e1-a5fe-fb08ca7d983b",
"appearance": {"font": {"fontFamily": "string",
"fontSources": [{"cssSrc": "string",
"family": "string",
"src": "string",
"style": "string",
"weight": "string"
}
]
},
"pallete": {"primary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
},
"secondary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
}
}
},
"paymentMethod": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"zipCode": "string"
},
"default": true,
"paymentMethodType": "CARD",
"nickname": "string",
"error": null,
"status": "COMPLETED",
"paymentMethodDetails": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
}
},
"childSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "NOTIFICATION_CREATED",
"mode": "TEXT_TO_ADD",
"error": null,
"createdAt": "string",
"expiresAt": "string",
"notification": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"channel": "TEXT",
"destination": ["+11111111111"
]
}
}
},
"hcpToken": "****"
}
}

Cancel CheckOut Session

Authorizations:

gateway

path Parameters

sessionId

required

string

sessionId

header Parameters

X-Merchant-Id

required

string <uuid>

Responses

Response samples

200
202
400
406
500

Content type

application/json

{"url": "string",
"data": {"checkoutSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"checkoutRequest": {"paymentType": "PRE_AUTH",
"authorizeCard": true,
"partialAuthorization": false,
"agent": {"firstName": "string",
"lastName": "string",
"isAccessVerified": true,
"userId": "string"
},
"merchantTransactionId": "string",
"paymentDescription": "string",
"statementDescriptorSuffix": "string",
"email": "string",
"phoneNumber": "string",
"amount": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"config": {"modes": ["PAYMENT"
],
"paymentMethod": [{"type": "CARD",
"channels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
}
],
"paymentMethodChannel": {"card": ["TERMINAL"
],
"cardChannels": [{"type": "TERMINAL",
"order": null,
"enabled": true
}
]
},
"privacyPolicyUrl": "string",
"senderEmailAddress": "string"
}
},
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"checkoutSessionStatus": "CREATED",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"vendorMerchantId": "string",
"paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"childSessionId": "8c886e65-64c0-43e1-a5fe-fb08ca7d983b",
"appearance": {"font": {"fontFamily": "string",
"fontSources": [{"cssSrc": "string",
"family": "string",
"src": "string",
"style": "string",
"weight": "string"
}
]
},
"pallete": {"primary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
},
"secondary": {"dark": "string",
"main": "string",
"light": "string",
"contrastText": "string"
}
}
},
"paymentMethod": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"zipCode": "string"
},
"default": true,
"paymentMethodType": "CARD",
"nickname": "string",
"error": null,
"status": "COMPLETED",
"paymentMethodDetails": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
}
},
"childSession": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "NOTIFICATION_CREATED",
"mode": "TEXT_TO_ADD",
"error": null,
"createdAt": "string",
"expiresAt": "string",
"notification": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"channel": "TEXT",
"destination": ["+11111111111"
]
}
}
},
"hcpToken": "****"
}
}

Create Payment

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET PAYMENT

Authorizations:

gateway

header Parameters

X-Merchant-Id required	string <uuid>
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Request Body schema: application/json
required

amount required	integer <int64>
	object (CustomerDetail)
	object
paymentType	string Deprecated Enum: "SALE" "PRE_AUTH"
authorizeCard	boolean Default: false false - SALE, true - PRE_AUTH; 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> required, only when making payment with stored paymentMethod;
	object (paymentMethodRequest) required, only for PayAndSave/OneTimePay
paymentDescription	string <= 100 characters Payment description that will be useful for user to identify the payment.
merchantTransactionId	string

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"customer": {"name": "string",
"email": "string",
"ssnLastFour": "string",
"phoneNumber": {"countryCode": "string",
"number": "string"
},
"dateOfBirth": "2000-01-30",
"statementDescriptorSuffix": "string",
"hsid": "string",
"metaData": {"property1": "string",
"property2": "string"
}
},
"metaData": {"property1": "string",
"property2": "string"
},
"paymentType": "SALE",
"authorizeCard": false,
"partialAuthorization": false,
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"paymentMethod": {"type": "CARD",
"vendorPaymentMethodId": "string",
"vendor": "STRIPE",
"sourceProvider": {"name": "CCG"
},
"savePaymentMethod": true,
"default": true
},
"paymentDescription": "string",
"merchantTransactionId": "string"
}

Response samples

200
202
400
406
500

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": 0,
"authorizedAmount": 0,
"capturedAmount": 0,
"description": "string",
"merchantTransactionId": "string",
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"authorizeCard": false,
"partialAuthorization": false,
"paymentType": "PRE_AUTH",
"currencyCode": "string",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"status": "INITIATED",
"vendor": "string",
"vendorPaymentId": "string",
"vendorMerchantId": "string",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
"metaData": {"property1": "string",
"property2": "string"
},
"paymentCancellationReason": "DUPLICATE",
"paymentCancellationMessage": "string",
"chargeDetails": {"vendorChargeId": "1e258ff9-48fc-496c-868f-234f4993888c",
"amount": 0,
"amountCaptured": 0,
"amountRefunded": 0,
"currencyCode": "string",
"statementDescriptor": "string",
"createdAt": 0,
"paymentMethodType": "CARD",
"card": {"last4": "string",
"expiryMonth": 0,
"expiryYear": 0,
"countryCode": "string",
"brand": "VISA"
},
"vendorPaymentMethodId": "string",
"chargeStatus": "SUCCEEDED",
"paid": false,
"chargeError": {"vendorErrorCode": "string",
"vendorErrorMessage": "string"
}
}
}
}

Get Payment Status by PaymentId

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET, PAYMENT

Authorizations:

gateway

path Parameters

paymentId

required

string

header Parameters

X-Merchant-Id required	string <uuid>
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Responses

Response samples

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": 0,
"authorizedAmount": 0,
"capturedAmount": 0,
"description": "string",
"merchantTransactionId": "string",
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"authorizeCard": false,
"partialAuthorization": false,
"paymentType": "PRE_AUTH",
"currencyCode": "string",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"status": "INITIATED",
"vendor": "string",
"vendorPaymentId": "string",
"vendorMerchantId": "string",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
"metaData": {"property1": "string",
"property2": "string"
},
"paymentCancellationReason": "DUPLICATE",
"paymentCancellationMessage": "string",
"chargeDetails": {"vendorChargeId": "1e258ff9-48fc-496c-868f-234f4993888c",
"amount": 0,
"amountCaptured": 0,
"amountRefunded": 0,
"currencyCode": "string",
"statementDescriptor": "string",
"createdAt": 0,
"paymentMethodType": "CARD",
"card": {"last4": "string",
"expiryMonth": 0,
"expiryYear": 0,
"countryCode": "string",
"brand": "VISA"
},
"vendorPaymentMethodId": "string",
"chargeStatus": "SUCCEEDED",
"paid": false,
"chargeError": {"vendorErrorCode": "string",
"vendorErrorMessage": "string"
}
}
}
}

Confirm Payment Status by PaymentId

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET, PAYMENT

Authorizations:

gateway

path Parameters

paymentId

required

string

header Parameters

X-Merchant-Id required	string <uuid>
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Responses

Response samples

202
400
403
500

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": 0,
"authorizedAmount": 0,
"capturedAmount": 0,
"description": "string",
"merchantTransactionId": "string",
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"authorizeCard": false,
"partialAuthorization": false,
"paymentType": "PRE_AUTH",
"currencyCode": "string",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"status": "INITIATED",
"vendor": "string",
"vendorPaymentId": "string",
"vendorMerchantId": "string",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
"metaData": {"property1": "string",
"property2": "string"
},
"paymentCancellationReason": "DUPLICATE",
"paymentCancellationMessage": "string",
"chargeDetails": {"vendorChargeId": "1e258ff9-48fc-496c-868f-234f4993888c",
"amount": 0,
"amountCaptured": 0,
"amountRefunded": 0,
"currencyCode": "string",
"statementDescriptor": "string",
"createdAt": 0,
"paymentMethodType": "CARD",
"card": {"last4": "string",
"expiryMonth": 0,
"expiryYear": 0,
"countryCode": "string",
"brand": "VISA"
},
"vendorPaymentMethodId": "string",
"chargeStatus": "SUCCEEDED",
"paid": false,
"chargeError": {"vendorErrorCode": "string",
"vendorErrorMessage": "string"
}
}
}
}

Create Setup PaymentMethod

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET PAYMENT_METHOD_ENTRY WALLET

Authorizations:

gateway

path Parameters

id

required

string <uuid>

header Parameters

X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Request Body schema: application/json
required

paymentMethodType	string Enum: "CARD" "BANK_ACCOUNT"
required	object (PaymentMethodRequest)

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/api-ccg/customers/{id}/setup-payment-methods

stage CCG Api Server

https://stg-wallet.healthsafepay.com/api-ccg/customers/{id}/setup-payment-methods

test CCG Api Server

https://test-wallet.healthsafepay.com/api-ccg/customers/{id}/setup-payment-methods

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/api-ccg/customers/{id}/setup-payment-methods

Request samples

Payload

Content type

application/json

{"paymentMethodType": "CARD",
"paymentMethod": {"type": "CARD",
"vendorPaymentMethodId": "string",
"vendor": "STRIPE",
"nickname": "string",
"sourceProvider": {"name": "CCG"
},
"card": {"type": "CARD",
"last4": "string",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
},
"agent": {"firstName": "string",
"lastName": "string",
"isAccessVerified": true,
"userId": "string"
},
"paymentMethodDetails": {"type": "CARD",
"last4": "string",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
},
"default": true
}
}

Response samples

202
400
500

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"platformVendorMerchantId": "string",
"vendorSetupPaymentMethodSecret": "string",
"status": "WAITING_FOR_CUSTOMER_CREATION",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"paymentMethodType": "CARD",
"error": {"errorGroup": "CUSTOMER_ERROR",
"errorCode": "string",
"message": "string",
"httpStatus": "400 BAD_REQUEST"
},
"warning": {"code": "string",
"title": "string",
"description": "string"
}
}
}

Get Setup PaymentMethod By Id

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET PAYMENT_METHOD_ENTRY WALLET

Authorizations:

gateway

path Parameters

id required	string <uuid>
setup-payment-method-id required	string <uuid>

header Parameters

X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/api-ccg/customers/{id}/setup-payment-methods/{setup-payment-method-id}

stage CCG Api Server

https://stg-wallet.healthsafepay.com/api-ccg/customers/{id}/setup-payment-methods/{setup-payment-method-id}

test CCG Api Server

https://test-wallet.healthsafepay.com/api-ccg/customers/{id}/setup-payment-methods/{setup-payment-method-id}

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/api-ccg/customers/{id}/setup-payment-methods/{setup-payment-method-id}

Response samples

200
202
400
500

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"platformVendorMerchantId": "string",
"vendorSetupPaymentMethodSecret": "string",
"status": "WAITING_FOR_CUSTOMER_CREATION",
"paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
"paymentMethodType": "CARD",
"error": {"errorGroup": "CUSTOMER_ERROR",
"errorCode": "string",
"message": "string",
"httpStatus": "400 BAD_REQUEST"
},
"warning": {"code": "string",
"title": "string",
"description": "string"
}
}
}

Get Payment Methods

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET

Authorizations:

gateway

path Parameters

id

required

string <uuid>

header Parameters

X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Responses

Response samples

200
400
500

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
},
"status": "INITIATED",
"vendor": "STRIPE",
"default": true,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"paymentMethodType": "CARD",
"vendorPaymentMethodId": "string"
}
]

Get Payment Method

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET

Authorizations:

gateway

path Parameters

id required	string <uuid>
payment-method-id required	string <uuid>

header Parameters

X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

stage CCG Api Server

https://stg-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

test CCG Api Server

https://test-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/api-ccg/customers/{id}/payment-methods/{payment-method-id}

Response samples

200
400
500

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
},
"status": "INITIATED",
"vendor": "STRIPE",
"default": true,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"paymentMethodType": "CARD",
"vendorPaymentMethodId": "string"
}
}

Update Payment Method Deprecated

This API is deprecated, please update to /payment-methods/{payment-method-id}

Authorizations:

gateway

path Parameters

id required	string <uuid>
payment-method-id required	string <uuid>

header Parameters

X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Request Body schema: application/json
required

default	boolean
expiryYear	integer <int32>
nameOnCard	string
expiryMonth	integer <int32>
nickname	string
zipCode	string

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

stage CCG Api Server

https://stg-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

test CCG Api Server

https://test-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/api-ccg/customers/{id}/payment-methods/{payment-method-id}

Request samples

Payload

Content type

application/json

{"default": true,
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"nickname": "string",
"zipCode": "string"
}

Response samples

202
500

Content type

application/json

{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
},
"status": "INITIATED",
"vendor": "STRIPE",
"default": true,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"paymentMethodType": "CARD",
"vendorPaymentMethodId": "string"
}
}

Delete Payment Method

ALLOWED SESSION MODES - PAYMENT_WITH_WALLET

Authorizations:

gateway

path Parameters

id required	string <uuid>
payment-method-id required	string <uuid>

header Parameters

X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>
X-Upstream-Env required	string Enum: "dev" "stage" "test" applicable only for Non prod

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

stage CCG Api Server

https://stg-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

test CCG Api Server

https://test-wallet.healthsafepay.com/api-ccg/customers/{id}/payment-methods/{payment-method-id}

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/api-ccg/customers/{id}/payment-methods/{payment-method-id}

Response samples

500

Content type

application/json

{"title": "string",
"detail": "string",
"status": 0
}

Update Payment Method by payment-method-id

Authorizations:

gateway

path Parameters

payment-method-id

required

string <uuid>

header Parameters

X-Upstream-Env required	string <string> Enum: "dev" "stage" "test" Specify the env value, Only required for Non-Prod
X-Merchant-Id required	string
X-Customer-Id required	string
X-Checkout-Id required	string <uuid>

Request Body schema: application/json

isDefault	boolean
nickname	string <= 30 characters can only contain letters and numbers
	object
	object (Agent)
	UpdateCard (object) or UpdateUSBankAccountDetails (object)

Responses

Request samples

Payload

Content type

application/json

{"isDefault": true,
"nickname": "string",
"card": {"expiryYear": 0,
"expiryMonth": 0,
"nameOnCard": "string",
"zipCode": "99950",
"manufacturerCard": true
},
"agent": {"firstName": "string",
"lastName": "string",
"isAccessVerified": true,
"userId": "string"
},
"paymentMethodDetails": {"type": "CARD",
"last4": "string",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"zipCode": "99950",
"manufacturerCard": true
}
}

Response samples

Content type

application/json

[{"url": "string",
"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"card": {"type": "CARD",
"last4": "string",
"status": "ACTIVE",
"cardBrand": "VISA",
"expiryYear": 0,
"nameOnCard": "string",
"expiryMonth": 0,
"vendorPaymentMethodFingerprint": "string"
},
"status": "INITIATED",
"vendor": "STRIPE",
"default": true,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"paymentMethodType": "CARD",
"vendorPaymentMethodId": "string"
}
}
]

Get Bank Routing Number

Authorizations:

gateway

path Parameters

routingNumber

required

string

Routing number belonging to the bank you are trying to locate

Responses

Dev CCG Api Server

https://dev-wallet.healthsafepay.com/api-ccg/customers/banks/routing/{routingNumber}

stage CCG Api Server

https://stg-wallet.healthsafepay.com/api-ccg/customers/banks/routing/{routingNumber}

test CCG Api Server

https://test-wallet.healthsafepay.com/api-ccg/customers/banks/routing/{routingNumber}

CCG Api Server

https://api.uhg.com/api/financial/commerce/checkout/v1/api-ccg/customers/banks/routing/{routingNumber}

Response samples

200

Content type

application/json

{"bankName": "string"
}

Convenient Checkout Api (v1)

Internal

Create Checkout Session

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create Child CheckOut Session

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get CheckOut Session

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Cancel CheckOut Session

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create Payment

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Payment Status by PaymentId

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Confirm Payment Status by PaymentId

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create Setup PaymentMethod

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Setup PaymentMethod By Id

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get Payment Methods

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get Payment Method

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update Payment Method Deprecated

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required