> ## Documentation Index > Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt > Use this file to discover all available pages before exploring further. # [Deprecated] Mark External Gateway Invoice As Paid > Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only. ## Endpoint Overview **POST** `https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid` Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external\_gateway\_payment/mark\_paid. This invoice-level API is kept for compatibility only. *** ## Authorization All UniBee Merchant API requests require authentication via API key. | Header | Required | Description | | --------------- | -------- | ------------------------------------- | | `Authorization` | Yes | Bearer `` | | `Content-Type` | Yes | `application/json` (for request body) | *** ## Parameters Parameters for this endpoint are listed below. The schema is also shown in the Try it panel. ### Request body | Name | Type | Required | Description | | ----------------------- | ------- | -------- | --------------------------------------------------------------------------------- | | `externalTransactionId` | string | Yes | External payment transaction id from gateway, used as idempotent key | | `gatewayId` | integer | No | Optional. External gateway id; omit to use invoice's current gateway for auth | | `invoiceId` | string | Yes | Invoice id | | `metadata` | object | No | Additional metadata from external gateway | | `paidTime` | integer | No | Paid time, UTC timestamp in seconds (optional, default now) | | `signature` | string | Yes | HMAC-SHA256(gatewayKey, invoiceId\|externalTransactionId\|timestamp), hex-encoded | | `timestamp` | integer | Yes | Request timestamp, UTC seconds, used for expiry check | *** ## Request examples ### cURL ```bash theme={null} curl -X POST "https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "externalTransactionId": "id_example", "gatewayId": 0, "invoiceId": "id_example", "metadata": {}, "paidTime": 0, "signature": "", "timestamp": 0 }' ``` ### Sandbox ```bash theme={null} curl -X POST "https://api-sandbox.unibee.top/merchant/invoice/external_gateway_invoice/mark_paid" \ -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "externalTransactionId": "id_example", "gatewayId": 0, "invoiceId": "id_example", "metadata": {}, "paidTime": 0, "signature": "", "timestamp": 0 }' ``` *** ## Response Success responses return a JSON envelope with `code`, `data`, `message`, `redirect`, and `requestId`. `code` `0` indicates success. | Field | Type | Description | | --------------------- | ------- | ---------------------------- | | `code` | integer | Response code. `0` = success | | `data` | object | Response payload | | `data.invoiceId` | string | Invoice id | | `data.paymentId` | string | Created or reused payment id | | `data.status` | string | Result status, e.g. success | | `data.subscriptionId` | string | Subscription id | | `message` | string | Human-readable message | | `requestId` | string | Request ID for support | *** ## Error handling | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------- | | 400 | Bad request — invalid or missing parameters. Check `message` in the body. | | 401 | Unauthorized — missing or invalid API key. | | 404 | Not found — invalid path or resource. | | 500 | Server error — retry with backoff. | When `code` in the response body is non-zero, check `message` for details. Use `requestId` when contacting support. ## OpenAPI ````yaml post /merchant/invoice/external_gateway_invoice/mark_paid openapi: 3.0.0 info: description: UniBee Api Server license: name: Apache-2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: OpenAPI UniBee version: daily,buildtime:202607240926 servers: - url: https://api.unibee.dev - url: https://api-sandbox.unibee.top security: - Authorization: [] paths: /merchant/invoice/external_gateway_invoice/mark_paid: post: tags: - Invoice summary: '[Deprecated] Mark External Gateway Invoice As Paid' description: >- Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only. requestBody: content: application/json: schema: $ref: >- #/components/schemas/unibee.api.merchant.invoice.MarkExternalGatewayInvoiceAsPaidReq required: true responses: '200': content: application/json: schema: properties: code: format: int properties: {} type: integer data: properties: invoiceId: description: Invoice id format: string properties: {} type: string paymentId: description: Created or reused payment id format: string properties: {} type: string status: description: Result status, e.g. success format: string properties: {} type: string subscriptionId: description: Subscription id format: string properties: {} type: string type: object merchantId: format: int64 properties: {} type: integer message: format: string properties: {} type: string redirect: format: string properties: {} type: string requestId: format: string properties: {} type: string type: object description: '' deprecated: true components: schemas: unibee.api.merchant.invoice.MarkExternalGatewayInvoiceAsPaidReq: deprecated: true description: >- Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only. properties: externalTransactionId: description: External payment transaction id from gateway, used as idempotent key format: string properties: {} type: string gatewayId: description: >- Optional. External gateway id; omit to use invoice's current gateway for auth format: int64 properties: {} type: integer invoiceId: description: Invoice id format: string properties: {} type: string metadata: additionalProperties: $ref: '#/components/schemas/interface' description: Additional metadata from external gateway format: map[string]interface {} properties: {} type: object paidTime: description: Paid time, UTC timestamp in seconds (optional, default now) format: int64 properties: {} type: integer signature: description: >- HMAC-SHA256(gatewayKey, invoiceId|externalTransactionId|timestamp), hex-encoded format: string properties: {} type: string timestamp: description: Request timestamp, UTC seconds, used for expiry check format: int64 properties: {} type: integer required: - invoiceId - externalTransactionId - timestamp - signature type: object interface: properties: {} type: object securitySchemes: Authorization: bearerFormat: JWT scheme: bearer type: http ````