Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinata.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a specific payment instruction by ID

​
Usage

import { PinataSDK } from "pinata";

const pinata = new PinataSDK({
  pinataJwt: process.env.PINATA_JWT!,
  pinataGateway: "example-gateway.mypinata.cloud",
});

const instruction = await pinata.x402.getPaymentInstruction(
  "01234567-89ab-cdef-0123-456789abcdef"
);

​
Returns

type PaymentInstructionResponse = {
  data: PaymentInstruction;
};

type PaymentInstruction = {
  id: string;
  version: number;
  payment_requirements: PaymentRequirement[];
  name: string;
  description?: string;
  created_at: string;
};

type PaymentRequirement = {
  asset: string;
  pay_to: string;
  network: "base" | "base-sepolia" | "eip155:8453" | "eip155:84532";
  amount: string;
  description?: string;
};

​
Parameters

​
id (required)

  • Type: string
The unique identifier of the payment instruction to retrieve 
const instruction = await pinata.x402.getPaymentInstruction(
  "01234567-89ab-cdef-0123-456789abcdef"
);