GET
/
farcaster
/
frame
/
transaction
/
pay
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/frame/transaction/pay \
  --header 'x-api-key: <api-key>'
{
  "transaction_frame": {
    "id": "<string>",
    "url": "<string>",
    "type": "pay",
    "config": {
      "allowlist_fids": [
        3
      ],
      "line_items": [
        {
          "name": "Payment",
          "description": "Payment for goods",
          "image": "https://i.imgur.com/ovGo3sz.png"
        }
      ],
      "action": {
        "text": "Pay",
        "text_color": "#FFFFFF",
        "button_color": "#000000"
      }
    },
    "status": "created",
    "transaction": {
      "to": {
        "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "network": "base",
        "token_contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
        "amount": 0.01
      }
    }
  }
}

​
Read more about this API here: Make agents prompt transactions

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
id
string
required

ID of the transaction mini app to retrieve

Response

200
application/json
Transaction mini app details
​
transaction_frame
object
required