> For the complete documentation index, see [llms.txt](https://passimpay.gitbook.io/passimpay-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://passimpay.gitbook.io/passimpay-api/check-invoice.md).

# Check invoice

<mark style="color:green;">`POST`</mark> `https://api.passimpay.io/v2/orderstatus`

This endpoint allows you to retrieve the status of a payment link.

**Rate Limit**: 10 requests per second

**Headers**

| Name           | Type   | Description                 |
| -------------- | ------ | --------------------------- |
| `x-signature`  | string | SHA-256 encrypted signature |
| `Content-Type` | string | application/json            |

**Request Body**

| Name         | Type    | Description                                                                                        |
| ------------ | ------- | -------------------------------------------------------------------------------------------------- |
| `platformId` | integer | Platform Id                                                                                        |
| `orderId`    | string  | Order ID of your platform. Type string, maximum length 64, allowed characters 'A-Za-z0-9+/=-:.,\_' |

#### Successful response (200)

| Name       | Type    | Description                                                                                                                                                               |
| ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| result     | integer | <p>Request result: <br><code>1</code>: success </p>                                                                                                                       |
| status     | string  | <p>Invoice status:<br><strong>paid</strong> - Invoice paid<br><strong>wait</strong> - Invoice pending payment<br><strong>error</strong> - Invoice canceled or expired</p> |
| amountPaid | string  | The amount of the invoice paid                                                                                                                                            |
| currency   | string  | The currency for the amountPaid field                                                                                                                                     |

#### Error Response (400)

| Name    | Type    | Description                                      |
| ------- | ------- | ------------------------------------------------ |
| result  | integer | <p>Request result: <br><code>0</code>: error</p> |
| message | string  | Error description                                |