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>"
}
'

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