X402.PaymentResponse (X402 v0.3.3)

Copy Markdown View Source

Encodes and decodes the x402 PAYMENT-RESPONSE header value.

The header is Base64-encoded JSON and is typically returned by a server after settlement.

Summary

Header Encoding

Decodes a Base64 PAYMENT-RESPONSE value to a map.

Encodes a settlement response payload to a Base64 header value.

Returns the canonical x402 header name.

Header Encoding

decode(value)

(since 0.1.0)
@spec decode(String.t()) :: {:ok, map()} | {:error, decode_error()}

Decodes a Base64 PAYMENT-RESPONSE value to a map.

Returns {:error, :payload_too_large} when the encoded value exceeds 8 KB. Returns {:error, :invalid_base64} when the value cannot be Base64-decoded. Returns {:error, :invalid_json} when JSON cannot be decoded to a map.

Examples

iex> {:ok, value} = X402.PaymentResponse.encode(%{"settled" => true})
iex> X402.PaymentResponse.decode(value)
{:ok, %{"settled" => true}}

iex> X402.PaymentResponse.decode("%%%")
{:error, :invalid_base64}

encode(payload)

(since 0.1.0)
@spec encode(map()) :: {:ok, String.t()} | {:error, encode_error()}

Encodes a settlement response payload to a Base64 header value.

Examples

iex> {:ok, value} = X402.PaymentResponse.encode(%{"settled" => true})
iex> X402.PaymentResponse.decode(value)
{:ok, %{"settled" => true}}

header_name()

(since 0.1.0)
@spec header_name() :: String.t()

Returns the canonical x402 header name.

Examples

iex> X402.PaymentResponse.header_name()
"PAYMENT-RESPONSE"

Types

decode_error()

@type decode_error() :: :invalid_base64 | :invalid_json | :payload_too_large

encode_error()

@type encode_error() :: :invalid_payload | :invalid_json