Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Frame

Get transaction pay mini app

Retrieves details about a transaction pay mini app by ID

get/v2/farcaster/frame/transaction/pay/

Query parameters

idstring required

ID of the transaction mini app to retrieve

Response

Success

Example response

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