# Check Payment

Check the status of a particular payment using the transaction ID.

#### **Method**

```

GET https://prod.ninjapay.me/sapi/v1/checkPayment

```

#### **Parameters**

**`tid: int`** // the transaction ID of the payment request.

#### **Response (send)**

```jsx
  {
      "tid": 210660277897,
      "payment_mode": "lightning",
      "wallet": "lbtc",
      "amount": -0.19362077,
      "receiver_ninjatag": null,
      "description": "sample_description",
      "created_at": 1661215876,
      "status": "paid", // undefined, pending, declined, paid status's by ninjapay
      "status_payee": "undefined", // undefined, pending, declined, paid (if payee decides to change the status from dashboard)
      "status_payer": "undefined", // undefined, pending, declined, paid (status from hosted checkout)
      "transaction_hash": null, // onchain transaction hash added by payer or payee from hosted checkout)
      "callback_url": null,
      "callback_status": null, // 200, 400, ... only triggers after payment
      "success_url": null,
      "hosted_checkout_url": null,
      "hosted_checkout_expiry": null,
      "customer_name": "Satoshi Nakamoto";
      "order_id": "21",
      "fiat_currency": "USD",
      "fiat_value": 4000.22,
      "extra": {
          "name": "nakamoto",
          "email": "sample@sample.com"
      },
      "chain_address": {
          "asset": "BTC",
          "chain_network": null,
          "address": null
      },
      "uri": null,
      "ttl": 10,
      "lightning_invoice": {
          "lightning_invoice_type": "lnurl",
          "expires_at": null,
          "payreq": "lnurl193620n1p3sgfyrpp5vsy5xumnky24rvt3aty94d4srrwy2rhp94yqzwu6er5x9eymh2zsdqawdsk6urvv40kgetnvdexjur5d9hkucqzpgxqzjhsp5uvmlp5xkteze6qmty35kuxe3j8cwzk25zsx7t9z84423peps9h9s9qyyssqp2ydxchkqceyzz4ma68kmjm58pr0pnx3anl48ajqlhfcgzqrpa0j7kxzjygdxujptkqjrkk6gxsag87yx9wcd7ugyauq45skvcg9aygqx5geqv"
      },
       "total_fee": {
          "network_fee": "0.00008161 btc",
          "service_fee": "0.00000002 btc (0.1%)",
          "gst_fee": null
      }
  }
```

#### Response (receive)

```jsx
   {
      "tid": 198660213997,
      "payment_mode": "onchain",
      "wallet": "btc",
      "amount": 1.10771927,
      "receiver_ninjatag": null,
      "description": "sample_description",
      "created_at": 1661215876,
      "status": "undefined", // undefined, pending, declined, paid status's by ninjapay
      "status_payee": "pending", // undefined, pending, declined, paid (if payee decides to change the status from dashboard)
      "status_payer": "paid", // undefined, pending, declined, paid (status from hosted checkout)
      "transaction_hash": "0x4b55b28d7380c2a11bf629754061835462260b38644f8364d2580cb17ac06f38", // onchain transaction hash added by payer or payee from hosted checkout)
      "callback_url": "https://yourwebhook.com",
      "callback_status": 201, // 200, 201, 400, ... only triggers after payment
      "success_url": "https://yoursuccessurl.com",
      "hosted_checkout_url": "https://checkout.ninjapay.me/198660213997",
      "hosted_checkout_expiry": 1814912992,
      "customer_name": null;
      "order_id": "210",
      "fiat_currency": "USD",
      "fiat_value": 2000.22,
      "extra": {
          "name": "nakamoto",
          "email": "sample@sample.com"
      },
      "chain_address": {
          "asset": "BTC",
          "chain_network": "ERC20",
          "address": "2NAyVsR6N8opLW9na23yBhkWqizEmwDVwvm"
      },
      "uri": "bitcoin:2NAyVsR6N8opLW9na23yBhkWqizEmwDVwvm?amount=0.00019362&label=sample_description&lightning=lntb193620n1p3sgfyrpp5vsy5xumnky24rvt3aty94d4srrwy2rhp94yqzwu6er5x9eymh2zsdqawdsk6urvv40kgetnvdexjur5d9hkucqzpgxqzjhsp5uvmlp5xkteze6qmty35kuxe3j8cwzk25zsx7t9z84423peps9h9s9qyyssqp2ydxchkqceyzz4ma68kmjm58pr0pnx3anl48ajqlhfcgzqrpa0j7kxzjygdxujptkqjrkk6gxsag87yx9wcd7ugyauq45skvcg9aygqx5geqv",
      "ttl": 10,
      "lightning_invoice": {
          "lightning_invoice_type": null,
          "expires_at": null,
          "payreq": null
      },
       "total_fee": {
          "network_fee": null,
          "service_fee": null,
          "gst_fee": null
      }
  }
```

#### **Code Example**

```jsx

const options = {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'API_KEY'
  },
  body: '{"tid": 21066027789}'
};

fetch('https://prod.ninjapay.me/sapi/v1/checkPayment', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
  
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ninjapay.gitbook.io/ninjapay-api-docs/coming-soon/api-reference-pro/check-payment.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
