V1
{
"request": {
"headers": {
"x-merchant-id": "<merchant-id>"
},
"method": "GET",
"path": "/checkout-sessions/{checkoutSessionId}?init=true" <MODIFIED>
},
"response": {
"checkoutSession": {
"appearance": {
"border": {
"alertBoxBorderRadius": "String",
"buttonBorderRadius": "String"
},
"font": {
"fontFamily": "String",
"fontSources": [
{
"cssSrc": "String",
"family": "String",
"src": "String",
"style": "String",
"weight": "String"
}
]
},
"height": {
"button": "Integer"
},
"merchantLogo": "String",
"palette": {
"primary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
},
"secondary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
}
},
"visibility": {
"headerLogo": "Boolean",
"hideApplicationLanguageSelector": "Boolean"
}
},
"checkoutRequest": {
"agent": {
"firstName": "String",
"isAccessVerified": "Boolean",
"lastName": "String",
"userId": "String"
},
"amount": "BigDecimal" <REMOVED>,
"appearance": {
"border": {
"alertBoxBorderRadius": "String",
"buttonBorderRadius": "String"
},
"font": {
"fontFamily": "String",
"fontSources": [
{
"cssSrc": "String",
"family": "String",
"src": "String",
"style": "String",
"weight": "String"
}
]
},
"height": {
"button": "Integer"
},
"merchantLogo": "String",
"palette": {
"primary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
},
"secondary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
}
},
"visibility": {
"headerLogo": "Boolean",
"hideApplicationLanguageSelector": "Boolean"
}
},
"assistedByAgent": {
"firstName": "String",
"isAccessVerified": "Boolean",
"lastName": "String",
"userId": "String"
},
"authorizeCard": "Boolean" <REMOVED>,
"config": {
"cardCategory": {
"medications": [
{
"label": "String",
"value": "String"
}
],
"type": "String"
},
"merchant": {
"id": "UUID" <REMOVED>,
"name": "String"
},
"modes": [
"String"
],
"options": {
"paymentMethodSaveMode": "String",
"preferredLanguage": "String",
"saveDisabled": "Boolean"
},
"paymentMethod": [
{
"channels": [
{
"enabled": "boolean",
"type": "String"
}
],
"type": "String"
}
] <REMOVED>,
"paymentMethodChannel": {
"bankAccount": [
"String"
],
"card": [
"String"
],
"cardChannels": [
{
"enabled": "boolean",
"type": "String"
}
]
},
"privacyPolicyUrl": "String",
"senderEmailAddress": "String"
},
"consent": {
"collectionDetails": "String",
"collectionTimestamp": "String",
"merchantConsentId": "String",
"merchantConsentText": "String"
} <REMOVED>,
"email": "String" <REMOVED>,
"firstName": "String" <REMOVED>,
"merchantTransactionId": "String" <REMOVED>,
"metadata": {
"String": "String"
} <REMOVED>,
"partialAuthorization": "Boolean" <REMOVED>,
"paymentDescription": "String" <REMOVED>,
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "Integer",
"qualifiedAmountDetails": {
"prescriptionAmount": "Integer"
}
},
"visionAmount": "Integer"
}
} <REMOVED>,
"paymentMethod": {
"id": "UUID",
"isDefault": "Boolean" <REMOVED>,
"nickname": "String" <REMOVED>,
"paymentMethodDetails": {
"accountHolderType": "String",
"accountType": "String",
"bankName": "String",
"cardBrand": "String",
"cardCategories": [
{
"medications": [
{
"label": "String",
"value": "String"
}
],
"type": "String"
}
],
"expiryMonth": "int",
"expiryYear": "int",
"last4": "String",
"nameOnAccount": "String",
"nameOnCard": "String",
"routingNumber": "String",
"status": "String",
"type": "String",
"vendorBankAccountId": "String",
"zipCode": "String"
} <REMOVED>,
"sourceProvider": {
"name": "String"
} <REMOVED>
},
"paymentType": "String" <REMOVED>,
"phoneNumber": "String" <REMOVED>,
"statementDescriptorSuffix": "String" <REMOVED>
},
"checkoutSessionStatus": "String",
"childSession": {
"createdAt": "String",
"error": "String" <MODIFIED>,
"expiresAt": "String",
"id": "UUID",
"mode": "String",
"notification": {
"channel": "String",
"destination": [
"String"
],
"id": "UUID"
},
"status": "String",
"warning": {
"code": "String",
"description": "String",
"title": "String"
}
},
"childSessionId": "String" <REMOVED>,
"createdAtUtc": "String",
"customerId": "String" <REMOVED>,
"error": {
"errorCode": "String",
"errorGroup": "String",
"httpStatus": "String",
"message": "String"
} <REMOVED>,
"expiresAtUtc": "String",
"features": {
"String": "Boolean"
} <REMOVED>,
"id": "UUID",
"merchant": {
"id": "UUID",
"name": "String"
},
"merchantId": "String" <REMOVED>,
"payment": {
"amount": "Long",
"authorizedAmount": "Long",
"capturedAmount": "Long",
"consent": {
"collectionDetails": "String" <REMOVED>,
"collectionTimestamp": "String" <REMOVED>,
"merchantConsentId": "String" <REMOVED>,
"merchantConsentText": "String"
},
"currencyCode": "String",
"description": "String",
"error": {
"errorCode": "String",
"errorGroup": "String",
"httpStatus": "String",
"message": "String"
} <REMOVED>,
"id": "UUID",
"merchantId": "String" <REMOVED>,
"merchantTransactionId": "String",
"metadata": {
"String": "String"
},
"partialAuthorization": "Boolean",
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "Integer",
"qualifiedAmountDetails": {
"prescriptionAmount": "Integer"
}
},
"visionAmount": "Integer"
}
},
"paymentMethod": {
"card": null,
"error": null,
"id": "UUID",
"isDefault": "Boolean",
"nickname": "String",
"paymentMethodDetails": {
"cardBrand": "String",
"cardCategories": [
{
"medications": [
{
"label": "String",
"value": "String"
}
],
"type": "String"
}
],
"expiryMonth": "int",
"expiryYear": "int",
"last4": "String",
"nameOnCard": "String",
"status": "String",
"type": "String",
"zipCode": "String"
},
"paymentMethodType": "String",
"status": "String",
"warning": null,
"zipCode": "String"
} <REMOVED>,
"paymentMethodId": "UUID" <REMOVED>,
"paymentType": "string" <REMOVED>,
"statementDescriptorSuffix": "String",
"status": "String"
},
"paymentId": "String" <REMOVED>,
"paymentMethod": {
"card": {
"cardBrand": "String",
"cardCategories": [
{
"id": "UUID",
"label": "String"
}
],
"cardChannel": "String",
"expiryMonth": "long",
"expiryYear": "long",
"last4": "String",
"manufacturerCard": "boolean",
"nameOnCard": "String",
"status": "String",
"type": "String (deprecated)",
"zipCode": "String"
} <REMOVED>,
"error": {
"errorCode": "String" <REMOVED>,
"errorGroup": "String" <REMOVED>,
"httpStatus": "String" <REMOVED>,
"message": "String" <REMOVED>
},
"id": "UUID",
"isDefault": "Boolean" <RENAMED>,
"nickname": "String",
"paymentMethodDetails": {
"cardBrand": "String",
"cardChannel": "String" <REMOVED>,
"expiryMonth": "int",
"expiryYear": "int",
"last4": "String",
"nameOnCard": "String"
},
"paymentMethodType": "String" <REMOVED>,
"status": "String",
"warning": {
"code": "String",
"description": "String",
"title": "String"
} <REMOVED>,
"zipCode": "String" <REMOVED>
},
"paymentMethodId": "String" <REMOVED>,
"telephonicEntryDetails": {
"error": {
"code": "String" <REMOVED>,
"message": "String"
},
"requestId": "UUID",
"status": "String",
"url": "String"
},
"vendorMerchantId": "String" <REMOVED>,
"warning": {
"code": "String",
"description": "String",
"title": "String"
}
},
"hcpToken": "String"
}
}
V2
{
"request": {
"headers": {
"x-merchant-id": "<merchant-id>"
},
"method": "GET",
"path": "/v2/checkout-sessions/{checkoutSessionId}?init=true" <MODIFIED>
},
"response": {
"checkoutSession": {
"appearance": {
"border": {
"alertBoxBorderRadius": "String",
"buttonBorderRadius": "String"
},
"font": {
"fontFamily": "String",
"fontSources": [
{
"cssSrc": "String",
"family": "String",
"src": "String",
"style": "String",
"weight": "String"
}
]
},
"height": {
"button": "Integer"
},
"merchantLogo": "String",
"palette": {
"primary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
},
"secondary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
}
},
"visibility": {
"headerLogo": "Boolean",
"hideApplicationLanguageSelector": "Boolean"
}
},
"checkoutRequest": {
"agent": {
"firstName": "String",
"isAccessVerified": "Boolean",
"lastName": "String",
"userId": "String"
},
"appearance": {
"border": {
"alertBoxBorderRadius": "String",
"buttonBorderRadius": "String"
},
"font": {
"fontFamily": "String",
"fontSources": [
{
"cssSrc": "String",
"family": "String",
"src": "String",
"style": "String",
"weight": "String"
}
]
},
"height": {
"button": "Integer"
},
"merchantLogo": "String",
"palette": {
"primary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
},
"secondary": {
"contrastText": "String",
"dark": "String",
"light": "String",
"main": "String"
}
},
"visibility": {
"headerLogo": "Boolean",
"hideApplicationLanguageSelector": "Boolean"
}
},
"assistedByAgent": {
"firstName": "String",
"isAccessVerified": "Boolean",
"lastName": "String",
"userId": "String"
},
"config": {
"cardCategory": {
"medications": [
{
"label": "String",
"value": "String"
}
],
"type": "String"
},
"merchant": {
"name": "String"
},
"modes": [
"String"
],
"options": {
"paymentMethodSaveMode": "String",
"preferredLanguage": "String",
"saveDisabled": "Boolean"
},
"paymentMethodChannel": {
"bankAccount": [
"String"
],
"card": [
"String"
],
"cardChannels": [
{
"enabled": "boolean",
"order": "Integer" <ADDED>,
"type": "String"
}
]
},
"privacyPolicyUrl": "String",
"senderEmailAddress": "String",
"splitTender": {
"enabled": "Boolean"
} <ADDED>
},
"customer": {
"email": "String",
"firstName": "String",
"lastName": "String",
"phoneNumber": {
"countryCode": "String",
"number": "String"
}
} <ADDED>,
"payment": {
"amount": "Long",
"authorizeCard": "Boolean",
"consent": {
"collectionDetails": {
"type": "String",
"web": {
"ipAddress": "String",
"userAgent": "String"
}
},
"collectionTimestamp": "String"
},
"description": "String",
"merchantTransactionId": "String",
"metadata": {
"String": "String"
},
"partialAuthorization": "Boolean",
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "Integer"
},
"visionAmount": "Integer"
}
},
"statementDescriptorSuffix": "String"
} <ADDED>,
"paymentMethod": {
"id": "UUID"
}
},
"checkoutSessionStatus": "String",
"childSession": {
"createdAt": "String",
"error": {
"detail": "String",
"errorDetails": {
"code": "String",
"message": "String"
},
"title": "String"
} <MODIFIED>,
"expiresAt": "String",
"id": "UUID",
"mode": "String",
"notification": {
"channel": "String",
"destination": [
"String"
],
"id": "UUID"
},
"status": "String",
"warning": {
"code": "String",
"description": "String",
"title": "String"
}
},
"createdAtUtc": "String",
"customer": {
"id": "String"
} <ADDED>,
"expiresAtUtc": "String",
"id": "UUID",
"merchant": {
"groupId": "String" <ADDED>,
"id": "UUID",
"name": "String"
},
"payment": {
"agent": {
"firstName": "String",
"isAccessVerified": "Boolean",
"lastName": "String",
"userId": "String"
} <ADDED>,
"amount": "Long",
"authRequired": "Boolean" <ADDED>,
"authorizeCard": "Boolean" <ADDED>,
"authorizedAmount": "Long",
"capturedAmount": "Long",
"checkoutId": "UUID" <ADDED>,
"consent": {
"merchantConsentText": "String"
},
"currencyCode": "String",
"description": "String",
"id": "UUID",
"merchant": {
"groupId": "String",
"id": "UUID",
"name": "String"
} <ADDED>,
"merchantTransactionId": "String",
"metadata": {
"String": "String"
},
"partialAuthorization": "Boolean",
"paymentAllocations": [
{
"amount": "Long",
"authorizedAmount": "Long",
"capturedAmount": "Long",
"error": {
"detail": "String",
"errorDetails": {
"code": "String",
"declineCode": "String",
"message": "String",
"networkAdviceCode": "String",
"networkDeclineCode": "String"
},
"title": "String"
},
"id": "UUID",
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "Integer",
"qualifiedAmountDetails": {
}
},
"visionAmount": "Integer"
}
},
"paymentMethod": {
"default": "Boolean",
"id": "UUID",
"nickname": "String",
"paymentMethodDetails": {
"accountHolderType": "String",
"accountType": "String",
"bankName": "String",
"cardBrand": "String",
"cardCategories": [
{
"medications": [
{
"label": "String",
"value": "String"
}
],
"type": "String"
}
],
"expiryMonth": "int",
"expiryYear": "int",
"last4": "String",
"nameOnAccount": "String",
"nameOnCard": "String",
"routingNumber": "String",
"status": "String",
"type": "String",
"vendorBankAccountId": "String",
"zipCode": "String"
},
"sourceProvider": {
"name": "String"
}
},
"remediation": {
"message": "String",
"type": "String"
},
"status": "String",
"vendor": {
"merchantId": "String",
"name": "String",
"paymentId": "String",
"paymentSecret": "String"
}
}
] <ADDED>,
"paymentDateUtc": "String" <ADDED>,
"paymentDetails": {
"healthcare": {
"iias": {
"qualifiedAmount": "Integer",
"qualifiedAmountDetails": {
"prescriptionAmount": "Integer"
}
},
"visionAmount": "Integer"
}
},
"statementDescriptorSuffix": "String",
"status": "String"
},
"paymentMethod": {
"default": "Boolean" <RENAMED>,
"error": {
"detail": "String" <ADDED>,
"errorDetails": {
"code": "String",
"message": "String"
} <ADDED>,
"title": "String" <ADDED>
},
"id": "UUID",
"nickname": "String",
"paymentMethodDetails": {
"cardBrand": "String",
"cardCategories": [
{
"medications": [
{
"label": "String",
"value": "String"
}
],
"type": "String"
}
] <ADDED>,
"expiryMonth": "int",
"expiryYear": "int",
"last4": "String",
"nameOnCard": "String",
"status": "String" <ADDED>,
"type": "String" <ADDED>,
"zipCode": "String" <ADDED>
},
"sourceProvider": {
"name": "String"
} <ADDED>,
"status": "String"
},
"telephonicEntryDetails": {
"error": {
"message": "String"
},
"requestId": "UUID",
"status": "String",
"url": "String"
},
"warning": {
"code": "String",
"description": "String",
"title": "String"
}
},
"hcpToken": "String"
}
}