List Payment Instructions

Returns a paginated list of payment instructions

GET /x402/payment_instructions

List Payment Instructions

cURL

curl --request GET \
  --url https://api.pinata.cloud/v3/x402/payment_instructions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pinata.cloud/v3/x402/payment_instructions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pinata.cloud/v3/x402/payment_instructions', 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.pinata.cloud/v3/x402/payment_instructions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinata.cloud/v3/x402/payment_instructions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pinata.cloud/v3/x402/payment_instructions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pinata.cloud/v3/x402/payment_instructions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "data": {
    "payment_instructions": [
      {
        "id": "<string>",
        "version": 123,
        "payment_requirements": [
          {
            "asset": "<string>",
            "pay_to": "<string>",
            "amount": "<string>",
            "description": "<string>"
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "next_page_token": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Pinata API JWT token

Query Parameters

limit · integer · default: 10

Number of items to return

Required range: 1 <= x <= 1000

pageToken · string

Token for pagination

cid · string

Filter by CID mapped (returns max 1 payment instruction)

name · string

Filter by name

id · string

Filter by ID

Response

200

application/json

Successful operation

data · object

Show child attributes