Neynar Documentation

Create transaction pay mini app

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

{
  "transaction_frame": {
    "id": "<string>",
    "url": "<string>",
    "type": "pay",
    "config": {
      "line_items": [
        {
          "name": "Payment",
          "description": "Payment for goods",
          "image": "https://i.imgur.com/ovGo3sz.png"
        }
      ],
      "allowlist_fids": [
        3
      ],
      "action": {
        "text": "Pay",
        "text_color": "#FFFFFF",
        "button_color": "#000000"
      }
    },
    "status": "created",
    "transaction": {
      "to": {
        "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "network": "ethereum",
        "token_contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
        "amount": 0.01
      }
    }
  }
}

POST

farcaster

frame

transaction

pay

Create transaction pay mini app

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

{
  "transaction_frame": {
    "id": "<string>",
    "url": "<string>",
    "type": "pay",
    "config": {
      "line_items": [
        {
          "name": "Payment",
          "description": "Payment for goods",
          "image": "https://i.imgur.com/ovGo3sz.png"
        }
      ],
      "allowlist_fids": [
        3
      ],
      "action": {
        "text": "Pay",
        "text_color": "#FFFFFF",
        "button_color": "#000000"
      }
    },
    "status": "created",
    "transaction": {
      "to": {
        "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "network": "ethereum",
        "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

Body

application/json

transaction

object

required

Show child attributes

transaction.to

TransactionFrameDestination · object

required

Show child attributes

transaction.to.address

string

required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

transaction.to.network

enum<string>

required

A blockchain network e.g. "ethereum", "optimism", "base", "arbitrum"

Available options:

ethereum,

optimism,

base,

arbitrum

transaction.to.token_contract_address

string

required

Token contract address for the payment (e.g. 0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 is USDC on Base)

Example:

"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"

transaction.to.amount

number

required

Amount to send (must be greater than 0)

Required range: x >= 1e-8

Example:

0.01

config

TransactionFrameConfig · object

required

Show child attributes

config.line_items

TransactionFrameLineItem · object[]

required

List of items included in the transaction

Minimum array length: 1

Show child attributes

config.line_items.name

string

required

Name of the line item in transaction

Example:

"Payment"

config.line_items.description

string

required

Description of the line item in transaction

Example:

"Payment for goods"

config.line_items.image

string

Optional image URL for the line item in transaction

Example:

"https://i.imgur.com/ovGo3sz.png"

config.allowlist_fids

integer<int32>[]

Optional list of FIDs that are allowed to use this transaction mini app

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0

config.action

TransactionFrameAction · object

Action button for primary CTA on the transaction mini app

Show child attributes

config.action.text

string

Custom text for action button

Example:

"Pay"

config.action.text_color

string

Custom text color for action button

Example:

"#FFFFFF"

config.action.button_color

string

Custom button color for action button

Example:

"#000000"

idem

string

An Idempotency key is a unique identifier for the request. Note:

This is used to prevent duplicate requests. Use the same idem key on retry attempts.
This should be a unique identifier for each request.
Recommended format is a 16-character string generated by the developer at the time of making this request.

Response

Success

transaction_frame

TransactionFrame · object

required

Show child attributes

transaction_frame.id

string

required

Unique identifier for the transaction mini app

transaction_frame.url

string<uri>

required

URL that can be used to access the transaction mini app

transaction_frame.type

enum<string>

required

Type of transaction mini app

Available options:

pay

transaction_frame.config

TransactionFrameConfig · object

required

Show child attributes

transaction_frame.config.line_items

TransactionFrameLineItem · object[]

required

List of items included in the transaction

Minimum array length: 1

Show child attributes

transaction_frame.config.line_items.name

string

required

Name of the line item in transaction

Example:

"Payment"

transaction_frame.config.line_items.description

string

required

Description of the line item in transaction

Example:

"Payment for goods"

transaction_frame.config.line_items.image

string

Optional image URL for the line item in transaction

Example:

"https://i.imgur.com/ovGo3sz.png"

transaction_frame.config.allowlist_fids

integer<int32>[]

Optional list of FIDs that are allowed to use this transaction mini app

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0

transaction_frame.config.action

TransactionFrameAction · object

Action button for primary CTA on the transaction mini app

Show child attributes

transaction_frame.config.action.text

string

Custom text for action button

Example:

"Pay"

transaction_frame.config.action.text_color

string

Custom text color for action button

Example:

"#FFFFFF"

transaction_frame.config.action.button_color

string

Custom button color for action button

Example:

"#000000"

transaction_frame.status

enum<string>

required

Available options:

created,

completed

transaction_frame.transaction

object

required

Show child attributes

transaction_frame.transaction.to

TransactionFrameDestination · object

required

Show child attributes

transaction_frame.transaction.to.address

string

required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

transaction_frame.transaction.to.network

enum<string>

required

A blockchain network e.g. "ethereum", "optimism", "base", "arbitrum"

Available options:

ethereum,

optimism,

base,

arbitrum

transaction_frame.transaction.to.token_contract_address

string

required

Token contract address for the payment (e.g. 0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 is USDC on Base)

Example:

"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"

transaction_frame.transaction.to.amount

number

required

Amount to send (must be greater than 0)

Required range: x >= 1e-8

Example:

0.01

User interactions Get transaction pay mini app

⌘I

Overview

Farcaster

Deploy onchain

Farcaster Hub API

Neynar SDK

Github

Create transaction pay mini app

Read more about this API here: Make agents prompt transactions

Authorizations

Body

Response

Overview

Farcaster

Deploy onchain

Farcaster Hub API

Neynar SDK

Github

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

Authorizations

Body

Response

Read more about this API here: Make agents prompt transactions