Settle an x402 payment on the blockchain

Security Requirements

Auth Types	Entities	Permissions	Required Roles
SERVICE, AGENT	PAYMENT	WRITE	PAYMENT:WRITE

POST /a2a-payments/v1/settle

Settle an x402 payment on the blockchain

cURL

curl --request POST \
  --url https://api.swarmd.ai/a2a-payments/v1/settle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentPayload": {
    "x402Version": 123,
    "scheme": "<string>",
    "network": "<string>",
    "payload": {
      "signature": "<string>",
      "authorization": {
        "from": "<string>",
        "to": "<string>",
        "value": 123,
        "validAfter": 123,
        "validBefore": 123,
        "nonce": "<string>"
      }
    }
  },
  "paymentRequirements": {
    "scheme": "<string>",
    "network": "<string>",
    "maxAmountRequired": 123,
    "resource": "<string>",
    "payTo": "<string>",
    "description": "<string>",
    "maxTimeoutSeconds": 123
  }
}
'

import requests

url = "https://api.swarmd.ai/a2a-payments/v1/settle"

payload = {
    "paymentPayload": {
        "x402Version": 123,
        "scheme": "<string>",
        "network": "<string>",
        "payload": {
            "signature": "<string>",
            "authorization": {
                "from": "<string>",
                "to": "<string>",
                "value": 123,
                "validAfter": 123,
                "validBefore": 123,
                "nonce": "<string>"
            }
        }
    },
    "paymentRequirements": {
        "scheme": "<string>",
        "network": "<string>",
        "maxAmountRequired": 123,
        "resource": "<string>",
        "payTo": "<string>",
        "description": "<string>",
        "maxTimeoutSeconds": 123
    }
}
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({
    paymentPayload: {
      x402Version: 123,
      scheme: '<string>',
      network: '<string>',
      payload: {
        signature: '<string>',
        authorization: {
          from: '<string>',
          to: '<string>',
          value: 123,
          validAfter: 123,
          validBefore: 123,
          nonce: '<string>'
        }
      }
    },
    paymentRequirements: {
      scheme: '<string>',
      network: '<string>',
      maxAmountRequired: 123,
      resource: '<string>',
      payTo: '<string>',
      description: '<string>',
      maxTimeoutSeconds: 123
    }
  })
};

fetch('https://api.swarmd.ai/a2a-payments/v1/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.swarmd.ai/a2a-payments/v1/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([
    'paymentPayload' => [
        'x402Version' => 123,
        'scheme' => '<string>',
        'network' => '<string>',
        'payload' => [
                'signature' => '<string>',
                'authorization' => [
                                'from' => '<string>',
                                'to' => '<string>',
                                'value' => 123,
                                'validAfter' => 123,
                                'validBefore' => 123,
                                'nonce' => '<string>'
                ]
        ]
    ],
    'paymentRequirements' => [
        'scheme' => '<string>',
        'network' => '<string>',
        'maxAmountRequired' => 123,
        'resource' => '<string>',
        'payTo' => '<string>',
        'description' => '<string>',
        'maxTimeoutSeconds' => 123
    ]
  ]),
  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.swarmd.ai/a2a-payments/v1/settle"

	payload := strings.NewReader("{\n  \"paymentPayload\": {\n    \"x402Version\": 123,\n    \"scheme\": \"<string>\",\n    \"network\": \"<string>\",\n    \"payload\": {\n      \"signature\": \"<string>\",\n      \"authorization\": {\n        \"from\": \"<string>\",\n        \"to\": \"<string>\",\n        \"value\": 123,\n        \"validAfter\": 123,\n        \"validBefore\": 123,\n        \"nonce\": \"<string>\"\n      }\n    }\n  },\n  \"paymentRequirements\": {\n    \"scheme\": \"<string>\",\n    \"network\": \"<string>\",\n    \"maxAmountRequired\": 123,\n    \"resource\": \"<string>\",\n    \"payTo\": \"<string>\",\n    \"description\": \"<string>\",\n    \"maxTimeoutSeconds\": 123\n  }\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.swarmd.ai/a2a-payments/v1/settle")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentPayload\": {\n    \"x402Version\": 123,\n    \"scheme\": \"<string>\",\n    \"network\": \"<string>\",\n    \"payload\": {\n      \"signature\": \"<string>\",\n      \"authorization\": {\n        \"from\": \"<string>\",\n        \"to\": \"<string>\",\n        \"value\": 123,\n        \"validAfter\": 123,\n        \"validBefore\": 123,\n        \"nonce\": \"<string>\"\n      }\n    }\n  },\n  \"paymentRequirements\": {\n    \"scheme\": \"<string>\",\n    \"network\": \"<string>\",\n    \"maxAmountRequired\": 123,\n    \"resource\": \"<string>\",\n    \"payTo\": \"<string>\",\n    \"description\": \"<string>\",\n    \"maxTimeoutSeconds\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swarmd.ai/a2a-payments/v1/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  \"paymentPayload\": {\n    \"x402Version\": 123,\n    \"scheme\": \"<string>\",\n    \"network\": \"<string>\",\n    \"payload\": {\n      \"signature\": \"<string>\",\n      \"authorization\": {\n        \"from\": \"<string>\",\n        \"to\": \"<string>\",\n        \"value\": 123,\n        \"validAfter\": 123,\n        \"validBefore\": 123,\n        \"nonce\": \"<string>\"\n      }\n    }\n  },\n  \"paymentRequirements\": {\n    \"scheme\": \"<string>\",\n    \"network\": \"<string>\",\n    \"maxAmountRequired\": 123,\n    \"resource\": \"<string>\",\n    \"payTo\": \"<string>\",\n    \"description\": \"<string>\",\n    \"maxTimeoutSeconds\": 123\n  }\n}"

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

200

{
  "success": true,
  "transactionHash": "<string>",
  "networkId": "<string>",
  "errorMessage": "<string>"
}

Authorizations

Authorization · string · header · required

JWT token (USER, AGENT, or SERVICE auth)

Body

application/json

paymentPayload · object · required

Show child attributes

paymentRequirements · object · required

Show child attributes

Response

200 - */*

OK

success · boolean

transactionHash · string

networkId · string

errorMessage · string