[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Fcrm-payments\u002Fget":3,"docs-tabs-entities\u002Fcrm-payments\u002Fget":6},{"content":4,"lastmod":5},"## Get a CRM payment\n\n`GET \u002Fv1\u002Fcrm-payments\u002F:id`\n\nReturns one CRM payment by ID, for example to check the amount after adding items or to find out whether the payment is marked as paid.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | yes | Payment ID. Payments of a CRM item: [`GET \u002Fv1\u002Fcrm-payments`](\u002Fdocs\u002Fentities\u002Fcrm-payments\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-payments\u002F563\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-payments\u002F563\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-payments\u002F563', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { data } = await res.json()\nconsole.log(`Payment ${data.accountNumber}: ${data.sum} ${data.currency}, paid: ${data.paid}`)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fcrm-payments\u002F563', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | `true` on success |\n| `data` | object | Payment object. Key payment fields are on the [CRM payments](\u002Fdocs\u002Fentities\u002Fcrm-payments) page |\n| `data.id` | number | Payment ID |\n| `data.accountNumber` | string | Payment number: the linked order number and the payment sequence number separated by `\u002F`, for example `1029\u002F1` |\n| `data.paid` | string | Paid mark: `Y` — paid, `N` — not paid |\n| `data.datePaid` | string \\| null | Time of the last \"paid\" mark, ISO 8601 with a time zone offset. `null` if the payment was never marked |\n| `data.empPaidId` | number \\| null | ID of the employee who last marked the payment. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `data.paySystemId` | number | Payment system ID. List: [`GET \u002Fv1\u002Fpay-systems`](\u002Fdocs\u002Fentities\u002Fpay-systems\u002Flist) |\n| `data.sum` | number | Payment amount. Made up of the payment items |\n| `data.currency` | string | Currency code. List: [`GET \u002Fv1\u002Fcurrencies`](\u002Fdocs\u002Fentities\u002Fcurrencies\u002Flist) |\n| `data.paySystemName` | string | Payment system name |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 563,\n    \"accountNumber\": \"1029\u002F1\",\n    \"paid\": \"N\",\n    \"datePaid\": null,\n    \"empPaidId\": null,\n    \"paySystemId\": 19,\n    \"sum\": 0,\n    \"currency\": \"USD\",\n    \"paySystemName\": \"Card payment\"\n  }\n}\n```\n\n## Error response example\n\n404 — no payment with this ID:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Payment has not been found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | No payment with this `id` |\n| 400 | `INVALID_ID` | `id` is not a positive integer |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the request. The reason is in `error.message` |\n| 403 | `BITRIX_ACCESS_DENIED` | The key's user has no access to the CRM item or the payment in Bitrix24 |\n| 403 | `SCOPE_DENIED` | The API key does not have the `crm` scope |\n| 401 | `TOKEN_MISSING` | The API key has no configured tokens |\n| 401 | `MISSING_API_KEY` | `X-Api-Key` is not provided |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**Removing the \"paid\" mark does not clear the time and author of the last mark.** After the mark is removed, the `datePaid` and `empPaidId` fields keep the values of the last mark. Only `paid` reflects the current state.\n\n## See also\n\n- [List CRM payments](\u002Fdocs\u002Fentities\u002Fcrm-payments\u002Flist)\n- [Update a CRM payment](\u002Fdocs\u002Fentities\u002Fcrm-payments\u002Fupdate)\n- [Set the \"paid\" mark](\u002Fdocs\u002Fentities\u002Fcrm-payments\u002Fpay)\n- [CRM payments](\u002Fdocs\u002Fentities\u002Fcrm-payments)\n","2026-10-09",{},1794739356898]