Types
x402
TypeScript types for the Pinata x402 SDK, including PaymentRequirement, payment instructions, and CID association responses for monetization.
Types for x402 monetization features
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
TypeScript types for the Pinata x402 SDK, including PaymentRequirement, payment instructions, and CID association responses for monetization.
type PaymentRequirement = {
asset: string;
pay_to: string;
network: "base" | "base-sepolia" | "eip155:8453" | "eip155:84532";
amount: string;
description?: string;
};
| Property | Type | Description |
|---|---|---|
asset | string | The USDC token contract address for the network (e.g., 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913 for Base) |
pay_to | string | The wallet address to receive payments |
network | "base" | "base-sepolia" | "eip155:8453" | "eip155:84532" | The blockchain network for transactions. Accepts friendly names or EIP-155 chain IDs |
amount | string | The amount required in USDC smallest units (6 decimals). Example: "10000" = $0.01 |
description | string | Optional description for this requirement |
type PaymentInstruction = {
id: string;
version: number;
payment_requirements: PaymentRequirement[];
name: string;
description?: string;
created_at: string;
};
| Property | Type | Description |
|---|---|---|
id | string | Unique identifier for the payment instruction |
version | number | Version number of the instruction |
payment_requirements | PaymentRequirement[] | Array of payment requirements |
name | string | Name of the payment instruction |
description | string | Optional description |
created_at | string | ISO timestamp of creation |
type CreatePaymentInstructionRequest = {
name: string;
payment_requirements: PaymentRequirement[];
description?: string;
};
type UpdatePaymentInstructionRequest = {
name?: string;
payment_requirements?: PaymentRequirement[];
description?: string;
};
type PaymentInstructionListQuery = {
limit?: number;
pageToken?: string;
cid?: string;
name?: string;
id?: string;
};
| Property | Type | Description |
|---|---|---|
limit | number | Maximum number of results to return |
pageToken | string | Pagination token for next page |
cid | string | Filter by associated CID |
name | string | Filter by instruction name |
id | string | Filter by instruction ID |
type PaymentInstructionListResponse = {
data: {
payment_instructions: PaymentInstruction[];
next_page_token?: string;
};
};
type PaymentInstructionResponse = {
data: PaymentInstruction;
};
type PaymentInstructionDeleteResponse = {
data: {};
};
type CidListQuery = {
limit?: number;
pageToken?: string;
};
type CidListResponse = {
data: {
cids: string[];
next_page_token?: string;
};
};
type CidAssociation = {
payment_instruction_id: string;
cid: string;
created_at: string;
};
| Property | Type | Description |
|---|---|---|
payment_instruction_id | string | ID of the associated payment instruction |
cid | string | The IPFS CID |
created_at | string | ISO timestamp of when the association was created |
type CidAssociationResponse = {
data: CidAssociation;
};
type CidRemoveResponse = {
data: {};
};