curl --request POST \
  --url https://api.example.com/spi/v1/balance-locks/{lock_id}/return-surplus \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Actor-Id: <x-actor-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Override-Reason: <x-override-reason>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/spi/v1/balance-locks/{lock_id}/return-surplus"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("X-Actor-Id", "<x-actor-id>")
	req.Header.Add("X-Override-Reason", "<x-override-reason>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    'X-Actor-Id': '<x-actor-id>',
    'X-Override-Reason': '<x-override-reason>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.example.com/spi/v1/balance-locks/{lock_id}/return-surplus', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/spi/v1/balance-locks/{lock_id}/return-surplus"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "X-Actor-Id": "<x-actor-id>",
    "X-Override-Reason": "<x-override-reason>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

{
  "lock_id": "01a17cf3-128e-7c41-9b2e-5d7a3f8c1e60",
  "surplus_amount": "0",
  "surplus_midaz_tx_id": "01a17dae-b16e-7f28-9a03-6b1c4d8e2f75",
  "returned_at": "2026-10-27T15:02:41Z"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The X-Idempotency header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0011",
  "title": "Not Found",
  "status": 404,
  "detail": "No entity was found for the given ID. Please make sure to use the correct ID.",
  "code": "PIX-0011"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0653",
  "title": "Conflict",
  "status": 409,
  "detail": "The balance lock's settlement is not final yet; retry once it is.",
  "code": "PIX-0653"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0655",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "An account required for this operation has no resolvable alias in the ledger.",
  "code": "PIX-0655"
}

{
  "code": "PIX-0000",
  "title": "Internal Server Error",
  "message": "The server encountered an unexpected error. Please try again later."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0652",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0652"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}