Request

The following API endpoint invocation example demonstrates how to retrieve a specific omnichannel link session status:

curl --location 'https://api-sandbox.ca-dev.co/v2/omnichannel/status/{statusTrackingId}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {Merchant Private API Key}'

Parameters

statusTrackingId- provided as part of the send-link Response payload

Note: This API endpoint requires the merchant private API key as the Authorization header bearer token.

Response

The status Response returns the most updated status for a given omnichannel link session.

Initial link payload example

{
    "success": true,
    "statusCode": "Initial",
    "data": {}
}

Successful Apply link payload example

{
    "success": true,
    "statusCode": "CallCenterLinkApplyFlowCompletedSuccessfully",
    "data": {
        "statusTrackingId": "{statusTrackingId}",
        "applicationId": "{application ID}",
        "correlationId": "{correlation ID}",
        "consumerId": "{ChargeAfter consumer ID}",
      	"accountToken": "{ChargeAfter account token}",	// Optional (depends on merchant flow)
        "tags": {
            "key1": "value1"
        },
        "consumerDetails": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "[email protected]",
            "mobilePhoneNumber": "1212123456",
            "shippingAddress": {
                "line1": "10th Main st.",
                "line2": "My Building, 4th floor",
                "city": "New York",
                "zipCode": "10019",
                "state": "NY"
            },
            "billingAddress": {
                "line1": "10th Main st.",
                "line2": "My Building, 4th floor",
                "city": "New York",
                "zipCode": "10019",
                "state": "NY"
            }
        },
        "availableCredit": [
            {
                "lender": {
                    "name": "{Lender name}"
                },
                "creditAmount": 15000.0
            }
        ]
    }
}

Successful Checkout link payload example

{
    "success": true,
    "statusCode": "CallCenterLinkCheckoutFlowCompletedSuccessfully",
    "data": {
        "statusTrackingId": "{statusTrackingId}",
        "applicationId": "{application ID}",
        "correlationId": "{correlation ID}",
        "consumerId": "{ChargeAfter consumer ID}",
        "tags": {
            "key1": "value1"
        },
        "consumerDetails": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "[email protected]",
            "mobilePhoneNumber": "1212123456",
            "shippingAddress": {
                "line1": "10th Main st.",
                "line2": "My Building, 4th floor",
                "city": "New York",
                "zipCode": "10019",
                "state": "NY"
            },
            "billingAddress": {
                "line1": "10th Main st.",
                "line2": "My Building, 4th floor",
                "city": "New York",
                "zipCode": "10019",
                "state": "NY"
            }
        },
        "token": "{ChargeAfter confirmation token}",
        "lender": {
            "id": "{ChargeAfter lender ID}",
            "name": "{Lender name}"
        },
        "orderInfo": {
            "totalAmount": "1300",
            "taxAmount": "300",
            "shippingAmount": "0"
        }
    }
}

Response Status Codes

Initial - The link was sent.
CallCenterLinkApplyPressed - The consumer clicked the apply link.
CallCenterLinkApplyFlowFailed - The application process failed.
CallCenterLinkApplyFlowCompletedSuccessfully - The application process completed successfully.
CallCenterLinkCheckoutPressed - The consumer clicked the checkout link.
CallCenterLinkCheckoutFlowFailed - The checkout process failed.
CallCenterLinkCheckoutFlowCompletedSuccessfully - The checkout process completed successfully.
CallCenterLinkCheckoutAndChargeCompletedSuccessfully - The checkout process completed and a charge was created.
CallCenterLinkHasExpired - The link expired.