Deployment status API

This endpoint takes a phone number of a merchant as a query parameter, and returns the status and id/name of the merchant on XPay environments (on staging or on production or on both).

REQUEST

Production(Live) server:

https://community.xpay.app/api/communities/deploy_status/?phone=+201220000009

or without country code in phone number:

https://community.xpay.app/api/communities/deploy_status/?phone=01220000009

Parameters

a query parameter contains the phone number as shown in the above link

Note: Country code is optional

Response

If merchants associated with the supplied phone number found then the response body with the following structure will return:

{
    "status": {
        "code": 200,
        "message": "success",
        "errors": []
    },
    "data": {
        "STAGING": [
            {
                "community_id": "JBPYOjm",
                "community_name": "Test Community 1"
            }
        ],
        "PRODUCTION": [
            {
                "community_id": "x3XdR31",
                "community_name": "test"
            }
        ]
    },
    "count": null,
    "next": null,
    "previous": null
}

If the Merchant found only on the staging, the response will be:

{
    "status": {
        "code": 200,
        "message": "success",
        "errors": []
    },
    "data": {
        "STAGING": [
            {
                "community_id": "JBPYOjm",
                "community_name": "Test Community 1"
            }
        ]
    },
    "count": null,
    "next": null,
    "previous": null
}

If no merchant found on any environment then a 404 reponse will return