Neynar Documentation

Create transaction pay mini app

cURL

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

Python Example

import requests

url = "https://api.neynar.com/v2/farcaster/frame/transaction/pay/"

payload = {
    "config": {
        "line_items": [\
            {\
                "description": "Payment for goods",\
                "name": "Payment",\
                "image": "https://i.imgur.com/ovGo3sz.png"\
            }\
        ],
        "action": {
            "button_color": "#000000",
            "text": "Pay",
            "text_color": "#FFFFFF"
        },
        "allowlist_fids": [3]
    },
    "transaction": { "to": {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "amount": 0.01,
            "token_contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"
        } },
    "idem": "<string>"
}
headers = {
    "x-api-key": "NEYNAR_API_DOCS",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: {
      line_items: [\
        {\
          description: 'Payment for goods',\
          name: 'Payment',\
          image: 'https://i.imgur.com/ovGo3sz.png'\
        }\
      ],
      action: {button_color: '#000000', text: 'Pay', text_color: '#FFFFFF'},
      allowlist_fids: [3]
    },
    transaction: {
      to: {
        address: '0x5a927ac639636e534b678e81768ca19e2c6280b7',
        amount: 0.01,
        token_contract_address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
      }
    },
    idem: '<string>'
  })
};

fetch('https://api.neynar.com/v2/farcaster/frame/transaction/pay/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP Example

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api.neynar.com/v2/farcaster/frame/transaction/pay/",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_POSTFIELDS => json_encode([\
    'config' => [\
        'line_items' => [\
                [\
                                'description' => 'Payment for goods',\
                                'name' => 'Payment',\
                                'image' => 'https://i.imgur.com/ovGo3sz.png'\
                ]\
        ],\
        'action' => [\
                'button_color' => '#000000',\
                'text' => 'Pay',\
                'text_color' => '#FFFFFF'\
        ],\
        'allowlist_fids' => [\
                3\
        ]\
    ],\
    'transaction' => [\
        'to' => [\
                'address' => '0x5a927ac639636e534b678e81768ca19e2c6280b7',\
                'amount' => 0.01,\
                'token_contract_address' => '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'\
        ]\
    ],\
    'idem' => '<string>'\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Content-Type: application/json",\
    "x-api-key: NEYNAR_API_DOCS"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go Example

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.neynar.com/v2/farcaster/frame/transaction/pay/"

payload := strings.NewReader("{\n  \"config\": {\n    \"line_items\": [\n      {\n        \"description\": \"Payment for goods\",
        \"name\": \"Payment\",
        \"image\": \"https://i.imgur.com/ovGo3sz.png\"\n      }\n    ],\n    \"action\": {\n      \"button_color\": \"#000000\",\n      \"text\": \"Pay\",\n      \"text_color\": \"#FFFFFF\"\n    },\n    \"allowlist_fids\": [\n      3\n    ]\n  },\n  \"transaction\": {\n    \"to\": {\n      \"address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n      \"amount\": 0.01,\n      \"token_contract_address\": \"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913\"\n    }\n  },\n  \"idem\": \"<string>\"}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Java Example

HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/frame/transaction/pay/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": {\n    \"line_items\": [\n      {\n        \"description\": \"Payment for goods\",\n        \"name\": \"Payment\",\n        \"image\": \"https://i.imgur.com/ovGo3sz.png\"\n      }\n    ],\n    \"action\": {\n      \"button_color\": \"#000000\",\n      \"text\": \"Pay\",\n      \"text_color\": \"#FFFFFF\"\n    },\n    \"allowlist_fids\": [\n      3\n    ]\n  },\n  \"transaction\": {\n    \"to\": {\n      \"address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n      \"amount\": 0.01,\n      \"token_contract_address\": \"0x833589fcd6edb6e08f4c7c32d4f71b54bda02913\"\n    }\n  },\n  \"idem\": \"<string>\"}")
  .asString();

Response Format

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

Error Response Format

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}

Authorizations

• x-api-key: string (header, required)