Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- SDK v1 to v2 migration guide
Create transaction pay mini app
Creates a new transaction pay mini app that can be used to collect payments through a 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": "base",
"token_contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
"amount": 0.01
}
},
"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"
}
},
"idem": "<string>"
}'{
"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
API key to authorize requests
Body
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
A blockchain network e.g. "base"
base Token contract address for the payment (e.g. 0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 is USDC on Base)
"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
Amount to send (must be greater than 0)
x >= 1e-80.01
List of items included in the transaction
Name of the line item in transaction
"Payment"
Description of the line item in transaction
"Payment for goods"
Optional image URL for the line item in transaction
"https://i.imgur.com/ovGo3sz.png"
Optional list of FIDs that are allowed to use this transaction mini app
The unique identifier of a farcaster user (unsigned integer)
Action button for primary CTA on the transaction mini app
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
Unique identifier for the transaction mini app
URL that can be used to access the transaction mini app
Type of transaction mini app
pay List of items included in the transaction
Name of the line item in transaction
"Payment"
Description of the line item in transaction
"Payment for goods"
Optional image URL for the line item in transaction
"https://i.imgur.com/ovGo3sz.png"
Optional list of FIDs that are allowed to use this transaction mini app
The unique identifier of a farcaster user (unsigned integer)
Action button for primary CTA on the transaction mini app
created, completed Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
A blockchain network e.g. "base"
base Token contract address for the payment (e.g. 0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 is USDC on Base)
"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
Amount to send (must be greater than 0)
x >= 1e-80.01
Was this page helpful?
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": "base",
"token_contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
"amount": 0.01
}
},
"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"
}
},
"idem": "<string>"
}'{
"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
}
}
}
}