Get Session Details

Quick Reference

• API Endpoint: GET v1/sessions/{sessionId}
• API Scope: merchant
• Purpose: Retrieve the status and details of a session, including payment and payment method information.
• Key Fields: sessionId, payment, paymentMethodResponse, agent, status
• Usage: Poll this endpoint to check session completion and obtain transaction details.
• See Also: Create Session Request/Response

Handling Get Session Details

• Use this API to regularly check the status of a session.
• Retrieve transaction, payment, and payment method details for the initiated session.

Sample Request

Sample Request – Get Session

curl --location --request GET 'https://api-stg.uhg.com/api/financial/commerce/nonprodcheckout/v1/sessions/579e2063-fe73-4e76-9bec-7a039f6e8b5b' \
--header 'X-Upstream-Env: dev' \
--header 'X-Merchant-Id: b955db5e-aef2-47de-bbb9-c80b9cc16e8f' \
--header 'Authorization: Bearer ********'

Sample Response

Sample Response – Get Session

{
  "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
  "data": {
    "paymentMethodResponse": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "card": {
        "type": "CARD",
        "last4": "string",
        "status": "ACTIVE",
        "cardBrand": "VISA",
        "expiryYear": 0,
        "nameOnCard": "string",
        "expiryMonth": 0,
        "zipCode": "99950",
        "manufacturerCard": true
      },
      "default": true,
      "paymentMethodType": "CARD",
      "nickname": "string",
      "paymentMethodDetails": {
        "type": "CARD",
        "last4": "string",
        "status": "ACTIVE",
        "cardBrand": "VISA",
        "expiryYear": 0,
        "nameOnCard": "string",
        "expiryMonth": 0,
        "zipCode": "99950",
        "manufacturerCard": true
      }
    },
    "payment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "amount": 0,
      "authorizedAmount": 0,
      "capturedAmount": 0,
      "description": "string",
      "merchantTransactionId": "string",
      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
      "paymentType": "SALE",
      "authorizeCard": false,
      "partialAuthorization": false,
      "currencyCode": "string",
      "customerId": "string",
      "status": "PENDING",
      "vendor": "STRIPE",
      "vendorPaymentId": "string",
      "vendorPaymentSecret": "string",
      "vendorMerchantId": "string",
      "statementDescriptorSuffix": "string",
      "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
      "paymentMethodType": "CARD",
      "checkoutId": "a21b4d66-7585-4979-80ec-60ea35b35821",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "customer": {
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com",
        "ssnLastFour": "string",
        "phoneNumber": {
          "countryCode": "string",
          "number": "string"
        },
        "dateOfBirth": "2000-12-30",
        "zip5": "99950",
        "hsid": "da31da38-f997-4079-8cce-c749b4067ecb",
        "enterpriseId": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        }
      },
      "paymentCancellationReason": "DUPLICATE",
      "paymentCancellationMessage": "string",
      "error": {
        "error": "string",
        "status": 0
      },
      "paymentDetails": {
        "healthcare": {
          "iias": {
            "qualifiedAmount": 0,
            "qualifiedAmountDetails": {
              "prescriptionAmount": 0
            }
          },
          "visionAmount": 0
        }
      },
      "consent": {
        "merchantConsentId": "string",
        "merchantConsentText": "string",
        "collectionTimestamp": "string",
        "collectionDetails": {
          "type": "WEB",
          "web": {
            "ipAddress": "string",
            "userAgent": "string"
          },
          "tel": {
            "inboundPhoneNumber": {
              "countryCode": "string",
              "number": "string"
            }
          }
        }
      },
      "paymentMethod": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "card": {
          "type": "CARD",
          "last4": "string",
          "status": "ACTIVE",
          "cardBrand": "VISA",
          "expiryYear": 0,
          "nameOnCard": "string",
          "expiryMonth": 0,
          "zipCode": "99950",
          "manufacturerCard": true
        },
        "default": true,
        "paymentMethodType": "CARD",
        "nickname": "string",
        "paymentMethodDetails": {
          "type": "CARD",
          "last4": "string",
          "status": "ACTIVE",
          "cardBrand": "VISA",
          "expiryYear": 0,
          "nameOnCard": "string",
          "expiryMonth": 0,
          "zipCode": "99950",
          "manufacturerCard": true
        }
      }
    },
    "agent": {
      "firstName": "string",
      "lastName": "string",
      "userId": "string",
      "isAccessVerified": true
    },
    "status": "INITIATED"
  }
}

Status

• status: Current status of the session (INITIATED, COMPLETED, FAILED)