Transaction status query request

Request

To get information about a transaction status or transaction details, Merchant must know the payment token and send an HTTP GET request to https://checkout.ecomcharge.com/ctp/api/checkouts/:payment_token, where payment_token should be replaced with the payment token that you have generated earlier.

Response

In the transaction section response parameters replicate token request parameters except for the additional ones:

Parameter	Type	Description
checkout	object
token * required	string	A payment token.
shop_id * required	integer	Shop ID that a transaction was done for.
gateway_response * required	object	A section that contains `payment` or `authorization` sections of payment or authorization transaction responses. Additionally, the parameter `uid` is added to the section. `uid` is the eComCharge gateway assigned ID to the transaction. You will use `uid` either to search transactions in the eComCharge backoffice or to send a transaction status query.
finished * required	boolean	`true` or `false`. It's the token status parameter. It is `true` if the transaction was processed by an external payment system.
expired * required	boolean	`true` or `false`. It's the token status parameter. It is `true` if a payment period allowed to pay has been expired.
test * required	boolean	`true` or `false`. It is `true` if the transaction is a test one.
status * required	string	If it is not `error`, it matches gateway response statuses.
message * required	string	If `status` is `error`, it has error descriptions. Refers to gateway error response message. Otherwise, it equals to `message` in `gateway_response`.

Response example

{
  "checkout":
  {
    "token": "3241e439f8c87d941d92621a4bdc030d4c9a69c67f3b0cfe12de4a13cc34aa51",
    "shop_id": 1,
    "transaction_type": "payment",
    "gateway_response": {
      "payment": {
        "uid": "1891-5fcb2bda3b",
        "auth_code":"654321",
        "bank_code":"05",
        "rrn":"999",
        "ref_id":"777888",
        "message":"Payment was approved",
        "gateway_id":317,
        "billing_descriptor":"TEST GATEWAY BILLING DESCRIPTOR",
        "status":"successful",
        "avs_cvc_verification": {
            "cvc_verification" : {
              "result_code": "M"
            },
            "avs_verification" : {
              "result_code": "M"
            }
        }
      }
    },
    "order": {
      "currency": "GBP",
      "amount": 4299,
      "description": "New description",
      "addtional_data" : {},
      "expired_at":null
    },
    "settings": {
      "success_url": "http://127.0.0.1:3003/success",
      "fail_url": "http://127.0.0.1:3003/fail",
      "decline_url": "http://127.0.0.1:3003/declined",
      "language": "en"
    },
    "customer": {
      "address": "Baker street 221b",
      "country": "GB",
      "city": "London",
      "email": "jake@example.com"
    },
    "finished": true,
    "expired": false,
    "test": true,
    "status": "successful",
    "message": "Successfully processed"
  }
}