> ## 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.

# Mark External Gateway Refund As Failed

> Mark refund as failed using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex).

## Endpoint Overview

**POST** `https://api.unibee.dev/merchant/payment/external_gateway_refund/mark_failed`

Mark refund as failed using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex).

***

## Authorization

All UniBee Merchant API requests require authentication via API key.

| Header          | Required | Description                           |
| --------------- | -------- | ------------------------------------- |
| `Authorization` | Yes      | Bearer `<your_api_key>`               |
| `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                                                                                           |
| ------------------ | ------- | -------- | ----------------------------------------------------------------------------------------------------- |
| `externalRefundId` | string  | Yes      | External refund transaction id from gateway, used as idempotent key                                   |
| `failureReason`    | string  | Yes      | Human-readable failure reason from external gateway                                                   |
| `gatewayId`        | integer | No       | External gateway id (optional), if omitted will be resolved from refundId                             |
| `refundId`         | string  | Yes      | The UniBee refundId                                                                                   |
| `signature`        | string  | Yes      | HMAC-SHA256 hex signature using External Gateway API Key over 'refundId\|externalRefundId\|timestamp' |
| `timestamp`        | integer | Yes      | Unix timestamp in seconds, used for signature and anti-replay                                         |

***

## Request examples

### cURL

```bash theme={null}
curl -X POST "https://api.unibee.dev/merchant/payment/external_gateway_refund/mark_failed" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalRefundId": "id_example",
  "failureReason": "",
  "gatewayId": 0,
  "refundId": "id_example",
  "signature": "",
  "timestamp": 0
}'
```

### Sandbox

```bash theme={null}
curl -X POST "https://api-sandbox.unibee.top/merchant/payment/external_gateway_refund/mark_failed" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalRefundId": "id_example",
  "failureReason": "",
  "gatewayId": 0,
  "refundId": "id_example",
  "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.paymentId` | string  | The related UniBee paymentId |
| `data.refundId`  | string  | The UniBee refundId          |
| `data.status`    | string  | Result status, e.g. failed   |
| `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/payment/external_gateway_refund/mark_failed
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:202603161017
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/payment/external_gateway_refund/mark_failed:
    post:
      tags:
        - Payment
      summary: Mark External Gateway Refund As Failed
      description: >-
        Mark refund as failed using external gateway result. Auth: OpenAPI +
        signature (HMAC-SHA256, hex).
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/unibee.api.merchant.payment.ExternalGatewayRefundMarkFailedReq
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      paymentId:
                        description: The related UniBee paymentId
                        format: string
                        properties: {}
                        type: string
                      refundId:
                        description: The UniBee refundId
                        format: string
                        properties: {}
                        type: string
                      status:
                        description: Result status, e.g. failed
                        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: ''
components:
  schemas:
    unibee.api.merchant.payment.ExternalGatewayRefundMarkFailedReq:
      description: >-
        Mark refund as failed using external gateway result. Auth: OpenAPI +
        signature (HMAC-SHA256, hex).
      properties:
        externalRefundId:
          description: External refund transaction id from gateway, used as idempotent key
          format: string
          properties: {}
          type: string
        failureReason:
          description: Human-readable failure reason from external gateway
          format: string
          properties: {}
          type: string
        gatewayId:
          description: >-
            External gateway id (optional), if omitted will be resolved from
            refundId
          format: int64
          properties: {}
          type: integer
        refundId:
          description: The UniBee refundId
          format: string
          properties: {}
          type: string
        signature:
          description: >-
            HMAC-SHA256 hex signature using External Gateway API Key over
            'refundId|externalRefundId|timestamp'
          format: string
          properties: {}
          type: string
        timestamp:
          description: Unix timestamp in seconds, used for signature and anti-replay
          format: int64
          properties: {}
          type: integer
      required:
        - refundId
        - timestamp
        - externalRefundId
        - signature
        - failureReason
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````