v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB

Agents

Create transaction pay mini app

Creates a new transaction pay mini app that can be used to collect payments through a mini app

post/v2/farcaster/frame/transaction/pay/

Request body

idemstring

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.

Example request

{
  "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"
    }
  }
}

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"
      }
    }
  }
}