---
updatedAt: 2026-06-11T11:59:29.000Z
agentTools:
  projectIndex: https://developer.coingate.com/llms.txt
---

# Create Void Request

Initiate a refund for a [void transaction](https://support.coingate.com/hc/en-us/articles/4902938327964), typically when:

* An order was overpaid,
* A transaction was received for a canceled or expired order, and
* The refundable amount exceeds the minimum threshold specified in the [Platforms API](https://developer.coingate.com/reference/platforms).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "v2",
    "version": "2"
  },
  "servers": [
    {
      "url": "https://api.coingate.com/api/v2"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/invoice/{uuid}/request-void": {
      "post": {
        "summary": "Create Void Request",
        "description": "",
        "operationId": "void-request",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "Invoice UUID",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "required": [
                  "address",
                  "crypto_platform_id"
                ],
                "properties": {
                  "address": {
                    "type": "string",
                    "description": "Crypto wallet address"
                  },
                  "additional_field": {
                    "type": "string",
                    "description": "Crypto addres memo or destination tag"
                  },
                  "crypto_platform_id": {
                    "type": "integer",
                    "description": "[Crypto Platform](https://developer.coingate.com/reference/platforms)",
                    "format": "int32"
                  },
                  "email": {
                    "type": "string",
                    "description": "Shopper's email"
                  },
                  "comment": {
                    "type": "string"
                  },
                  "accept_payment": {
                    "type": "boolean",
                    "description": "If payment was paid in full, you can mark the ‘Accept Payment’ checkbox on the refund form and we will make every attempt to process this payment, however, it may not be possible and a refund may be required."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\": 9,\n  \"status\": \"pending\",\n  \"address\": \"36c3KtqTpnhCRXp5179HR6hpKxP2XDahKF\",\n  \"comment\": null,\n  \"additional_field\": null,\n  \"accept_payment\": false,\n  \"currency\": {\n    \"id\": 1,\n    \"title\": \"Bitcoin\",\n    \"symbol\": \"BTC\",\n    \"platform\": {\n      \"id\": 5,\n      \"title\": \"Bitcoin\"\n    }\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 9,
                      "default": 0
                    },
                    "status": {
                      "type": "string",
                      "example": "pending"
                    },
                    "address": {
                      "type": "string",
                      "example": "36c3KtqTpnhCRXp5179HR6hpKxP2XDahKF"
                    },
                    "comment": {},
                    "additional_field": {},
                    "accept_payment": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "currency": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "title": {
                          "type": "string",
                          "example": "Bitcoin"
                        },
                        "symbol": {
                          "type": "string",
                          "example": "BTC"
                        },
                        "platform": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer",
                              "example": 5,
                              "default": 0
                            },
                            "title": {
                              "type": "string",
                              "example": "Bitcoin"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errors\": {\n    \"fields\": {\n      \"crypto_platform_id\": [\n        \"not found or does not belong to this currency\"\n      ],\n      \"base\": [\n        \"Refund is not eligible for this order\"\n      ]\n    },\n    \"full_messages\": [\n      \"Crypto platform not found or does not belong to this currency\",\n      \"Refund is not eligible for this order\"\n    ]\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "object",
                      "properties": {
                        "fields": {
                          "type": "object",
                          "properties": {
                            "crypto_platform_id": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "not found or does not belong to this currency"
                              }
                            },
                            "base": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "Refund is not eligible for this order"
                              }
                            }
                          }
                        },
                        "full_messages": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "Crypto platform not found or does not belong to this currency"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```