Skip to content

docs(spec): clarify HTTP payment required header #2320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EfeDurmaz16 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(spec): clarify HTTP payment required header #2320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions specs/transports-v2/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ The server indicates payment is required using the HTTP 402 "Payment Required" s
**Mechanism**: HTTP 402 status code with `PAYMENT-REQUIRED` header
**Data Format**: Base64-encoded `PaymentRequired` schema in header

The `PAYMENT-REQUIRED` header is the canonical HTTP transport location for the
`PaymentRequired` object. A response body may duplicate the same information
for humans or backward compatibility, but clients and crawlers must not depend
on the body alone for x402 protocol data.

**Example:**

```http
Expand Down
4 changes: 3 additions & 1 deletion specs/x402-specification-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ This section defines the core data structures used in the x402 protocol. These a

**5.1.1 JSON Payload**

When a resource server requires payment, it responds with a payment required signal and a JSON payload containing payment requirements. Example:
When a resource server requires payment, it responds with a payment required signal containing the `PaymentRequired` object. The transport defines where this object is carried. For HTTP, the canonical wire location is the base64-encoded `PAYMENT-REQUIRED` response header, not only the response body. See [HTTP Payment Required Signaling](./transports-v2/http.md#payment-required-signaling).

Example `PaymentRequired` object:

```json
{
Expand Down
Loading