---
updatedAt: 2026-05-27T08:29:42.000Z
agentTools:
  projectIndex: https://docs.bridgeapi.io/llms.txt
---

# Create refund

Create a refund request

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Bridge API",
    "version": "2025-01-15",
    "description": "Bridge provides an Open Banking API to initiate payments and aggregate financial data.  \nOur API uses standards such as HTTP verbs, RESTful routing and JSON for payloads.",
    "license": {
      "name": "Proprietary",
      "url": "https://docs.bridgeapi.io"
    },
    "contact": {
      "name": "BridgeAPI",
      "url": "https://bridgeapi.io",
      "email": "support@bridgeapi.io"
    }
  },
  "servers": [
    {
      "description": "Production",
      "url": "https://api.bridgeapi.io"
    }
  ],
  "tags": [
    {
      "name": "Payment account",
      "description": "Our Payment Account service empowers you to effortlessly collect payments and efficiently manage refunds and payouts.\nWe handle the intricacies of payment management on your behalf, simplifying your financial operations."
    }
  ],
  "paths": {
    "/v3/payment/payment-account/refunds": {
      "summary": "Refunds",
      "parameters": [
        {
          "$ref": "#/components/parameters/version"
        }
      ],
      "post": {
        "operationId": "CreateRefund",
        "summary": "Create refund",
        "description": "Create a refund request",
        "tags": [
          "Payment account"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "payment_account_transaction_id",
                  "amount"
                ],
                "properties": {
                  "payment_account_transaction_id": {
                    "type": "string",
                    "description": "The id of the payment account transaction you want to refund",
                    "example": "9f7052e8-96cd-45da-8e5c-08c82ef83164"
                  },
                  "amount": {
                    "type": "number",
                    "description": "The amount you wish to refund (positive and up to 2 decimals). You can partially refund the payment transaction.",
                    "example": 10
                  },
                  "client_reference": {
                    "type": "string",
                    "description": "An optional reference to link this refund request to your system (100 characters max.)",
                    "example": "client-reference"
                  },
                  "description": {
                    "type": "string",
                    "description": "This description is only for an internal purpose and will allow to have information on the Dashboard (140 characters max.)",
                    "example": "My product refund description"
                  },
                  "end_to_end_id": {
                    "type": "string",
                    "example": "E2E_TEST-123",
                    "description": "Technical id between you, Bridge and the bank (35 char. max.)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Refund creation response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "5d838eace5f64cb3b8b395ae5cf4a6fe"
                    },
                    "payment_account_transaction_id": {
                      "type": "string",
                      "example": "9f7052e8-96cd-45da-8e5c-08c82ef83164"
                    },
                    "amount": {
                      "type": "number",
                      "example": 150
                    },
                    "currency": {
                      "type": "string",
                      "example": "EUR"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "created",
                        "processing",
                        "in_transit",
                        "paid",
                        "canceled",
                        "rejected",
                        "failed",
                        "recalled"
                      ],
                      "example": "paid"
                    },
                    "client_reference": {
                      "type": "string",
                      "description": "Your internal reference for reconciliation",
                      "example": "client-ref-1234"
                    },
                    "description": {
                      "type": "string",
                      "description": "Your internal description",
                      "example": "Reimbursement B"
                    },
                    "end_to_end_id": {
                      "$ref": "#/paths/~1v3~1payment~1payment-account~1refunds/post/requestBody/content/application~1json/schema/properties/end_to_end_id"
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-05-03T14:13:43.618Z"
                    },
                    "updated_at": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2023-05-03T14:13:50.021Z"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "version": {
        "in": "header",
        "name": "Bridge-Version",
        "schema": {
          "type": "string",
          "enum": [
            "2025-01-15"
          ],
          "default": "2025-01-15"
        },
        "required": true,
        "description": "The Bridge API version"
      }
    },
    "securitySchemes": {
      "clientIdAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Id"
      },
      "clientSecretAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Secret"
      }
    }
  },
  "security": [
    {
      "clientIdAuth": [],
      "clientSecretAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  }
}
```