Create Payment Instruction

Creates a new payment instruction

POST /x402/payment_instructions

Create Payment Instruction

cURL

curl --request POST \
  --url https://api.pinata.cloud/v3/x402/payment_instructions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "payment_requirements": [
    {
      "asset": "<string>",
      "pay_to": "<string>",
      "amount": "<string>",
      "description": "<string>"
    }
  ],
  "description": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "payment_requirements": [
        {
            "asset": "<string>",
            "pay_to": "<string>",
            "amount": "<string>",
            "description": "<string>"
        }
    ],
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    payment_requirements: [
      {
        asset: '<string>',
        pay_to: '<string>',
        amount: '<string>',
        description: '<string>'
      }
    ],
    description: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'payment_requirements' => [
        [
                'asset' => '<string>',
                'pay_to' => '<string>',
                'amount' => '<string>',
                'description' => '<string>'
        ]
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"payment_requirements\": [\n    {\n      \"asset\": \"<string>\",\n      \"pay_to\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pinata.cloud/v3/x402/payment_instructions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"payment_requirements\": [\n    {\n      \"asset\": \"<string>\",\n      \"pay_to\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"payment_requirements\": [\n    {\n      \"asset\": \"<string>\",\n      \"pay_to\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}"

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

200

{
  "data": {
    "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"
  }
}

Authorizations

Authorization · string · header · required

Pinata API JWT token

Body

application/json

name · string · required

Name of the payment instruction

payment_requirements · object[] · required

Minimum array length: 1

Show child attributes

description · string

Description of the payment instruction

Response

200

application/json

Successful operation

data · object

Show child attributes