Status request

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 Public API Key}'

Parameters:

statusTrackingId- provided as part of the send-link API response payload

This API endpoint requires the merchant public API key as the Authorization header bearer token.

Response

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

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"
        }
    }
}

Here are the different status codes that may be provided in the response payload:

Initial
CallCenterLinkApplyPressed
CallCenterLinkApplyFlowFailed
CallCenterLinkApplyFlowCompletedSuccessfully
CallCenterLinkCheckoutPressed
CallCenterLinkCheckoutFlowFailed
CallCenterLinkCheckoutFlowCompletedSuccessfully
CallCenterLinkCheckoutAndChargeCompletedSuccessfully
CallCenterLinkHasExpired