Skip to content

Status query

Due to the transaction processing flow of the payment method provider or of your system, you might need to get the actual status and details of a transaction. For this, you can a query request by the uid or the tracking_id.

Get a transaction status by uid

To request a transaction status by the uid, send a GET request with your credentials to https://api.begateway.com/beyag/transactions/:uid.

Example of the response
{
"transaction": {
    "uid": "ab050348-3478-44ac-b92b-b1295f19cff6",
    "type": "payment",
    "status": "successful",
    "amount": 100,
    "currency": "USD",
    "description": "Payment",
    "created_at": "2018-06-19T16:15:50Z",
    "updated_at": "2018-06-19T16:15:50Z",
    "method_type": "m_pesa",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/ab050348-3478-44ac-b92b-b1295f19cff6/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
    "payment": {
    "status": "successful",
    "gateway_id": null,
    "ref_id": "ws_CO_02112017160241730"
    },
    ...
    "customer": {},
    "additional_data": {
    "payment_method": {
        "type": "alternative"
    }
    }
}
}

Get a transaction status by tracking_id

To request a transaction status by the tracking_id, send a GET request to https://api.begateway.com/beyag/transactions/tracking_id/:tracking_id.

Example of the response
{
"transactions": [
    {
    "uid": "1829b76e-1c64-47f1-b6c2-83f82c9de6a1",
    "type": "payment",
    "status": "initial",
    "amount": 100,
    "currency": "USD",
    "description": "Payment",
    "created_at": "2018-06-19T16:09:35Z",
    "updated_at": "2018-06-19T16:09:35Z",
    "method_type": "safety_pay",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/1829b76e-1c64-47f1-b6c2-83f82c9de6a1/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
    "payment": {
        "status": "initial",
        "gateway_id": null
    },
    ...
    "customer": {},
    "tracking_id": "123",
    "additional_data": {
        "payment_method": {
        "type": "alternative"
        }
    }
    },
    {
    "uid": "5aceab18-e273-469c-9ecc-7161fdac6f70",
    "type": "payment",
    "status": "successful",
    "amount": 100,
    "currency": "EUR",
    "description": "Payment",
    "created_at": "2018-06-19T16:09:35Z",
    "updated_at": "2018-06-19T16:09:35Z",
    "method_type": "m_pesa",
    "receipt_url": "https://demo-backoffice.begateway.com/customer/transactions/5aceab18-e273-469c-9ecc-7161fdac6f70/11443f39ae75aa1f955a9c9283cd5045bfb0413b65d666f834a9da4e7d3926b5",
    "payment": {
        "status": "successful",
        "gateway_id": null,
        "ref_id": "ws_CO_02112017160241730"
    },
    ...  
    "customer": {},
    "tracking_id": "123",
    "additional_data": {
        "payment_method": {
        "type": "alternative"
        }
    }
    }
]
}