# Check Payment Link Status

> Retrieve the status and properties of a payment link.

Source: https://help.boltapp.com/gaming/guide/bolt-api/check-payment-link

**Method**: `GET`

**Path**: `/v1/gaming/payment_links/\{PAYMENT_LINK_ID}`

**Environments**

* Sandbox: [https://api-sandbox.boltapp.com](https://api-sandbox.boltapp.com)
* Production: [https://api.boltapp.com](https://api.boltapp.com)

## Header Parameters [#header-parameters]

| Parameter           | Type     | Required | Description                                                                                      |
| ------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------ |
| `X-API-KEY`         | `string` | ✅        | Your secret API key. Used to authenticate server-to-server requests.                             |
| `X-PUBLISHABLE-KEY` | `string` | ✅        | Your publishable API key. Identifies your merchant account in client-facing and server requests. |

## Path Parameters [#path-parameters]

| Parameter         | Type     | Required | Description                                                     |
| ----------------- | -------- | -------- | --------------------------------------------------------------- |
| `PAYMENT_LINK_ID` | `string` | ✅        | The payment link generated by the **Create Payment Link** call. |

```bash title="Request"
curl --request GET \
--url https://api-sandbox.boltapp.com/v1/gaming/payment_links/{PAYMENT_LINK_ID} \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'X-PUBLISHABLE-KEY: YOUR_PUBLISHABLE_KEY'
```

```json title="Response"
{
	"transaction": {
		"reference": "FQFQ-4VVR-BBBX",
		"status": "authorized"
	},
	"payment_link_properties": {
		"id": "9qpT4pVhkniHLzGapsAxz6",
		"link": "https://abcdefake.c-sandbox.boltapp.com/o?order_token=819c220124dfe16f63066f77378e3a544b42d230597eff401214627ec67e2734&payment_link_id=9qpT4pVhkniHLzGapsAxz6&publishable_key=THF7DjHcgSO8.P4WwM-oR233w.f3a8f6a469e053bebdbee21f59e13100748822ad89ba5f8808ff3fd3959d026b",
		"user_id": "0987654321",
		"game_id": "1234567890",
		"item": {
			"name": "Gems Pack",
			"price": 699,
			"currency": "USD"
		},
		"redirect_url": "bubble-merge://bolt-webcheckout/success",
		"metadata": "{\"beamable_id\":\"9876543210\",\"greeting\":\"Hello World!\"}",
		"expiration": "2025-01-01T00:00:00Z"
	}
}
```