Settle

Finalizes and records delegated permission usage after service delivery.

POST /x402/settle

Settle Permission

cURL

curl --request POST \
  --url https://api.sandbox.nevermined.app/api/v1/x402/settle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessToken": "x402_eyJhbGciOiJIUzI1NiIs...",
  "agentId": "did:nv:abc123...",
  "creditsUsed": 5
}
'

import requests

url = "https://api.sandbox.nevermined.app/api/v1/x402/settle"

payload = {
    "accessToken": "x402_eyJhbGciOiJIUzI1NiIs...",
    "agentId": "did:nv:abc123...",
    "creditsUsed": 5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessToken: 'x402_eyJhbGciOiJIUzI1NiIs...',
    agentId: 'did:nv:abc123...',
    creditsUsed: 5
  })
};

fetch('https://api.sandbox.nevermined.app/api/v1/x402/settle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.nevermined.app/api/v1/x402/settle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accessToken' => 'x402_eyJhbGciOiJIUzI1NiIs...',
    'agentId' => 'did:nv:abc123...',
    'creditsUsed' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.sandbox.nevermined.app/api/v1/x402/settle"

	payload := strings.NewReader("{\n  \"accessToken\": \"x402_eyJhbGciOiJIUzI1NiIs...\",\n  \"agentId\": \"did:nv:abc123...\",\n  \"creditsUsed\": 5\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.nevermined.app/api/v1/x402/settle")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessToken\": \"x402_eyJhbGciOiJIUzI1NiIs...\",\n  \"agentId\": \"did:nv:abc123...\",\n  \"creditsUsed\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.nevermined.app/api/v1/x402/settle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessToken\": \"x402_eyJhbGciOiJIUzI1NiIs...\",\n  \"agentId\": \"did:nv:abc123...\",\n  \"creditsUsed\": 5\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "permissionHash": "<string>",
  "creditsSettled": 123,
  "remainingCredits": 123,
  "txHash": "<string>"
}

Authorizations

Authorization · string · header · required

Your Nevermined API Key (starts with 'nvm:'). Get one at nevermined.app under Settings > API Keys.

Body

application/json

Settlement request

accessToken · string · required

agentId · string · required

creditsUsed · integer · required

requestMetadata · object

Response

200

application/json

Settlement complete

success · boolean

permissionHash · string

creditsSettled · integer

remainingCredits · integer

txHash · string