Update Payment Instruction

Updates an existing payment instruction

PATCH /x402/payment_instructions/{id}

Update Payment Instruction

cURL

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

Path Parameters

id · string · required

Payment instruction ID

Body

application/json

name · string

Name of the payment instruction

description · string

Description of the payment instruction

payment_requirements · object[]

Minimum array length: 1

Show child attributes

Response

200

application/json

Successful operation

data · object

Show child attributes