zkbcy7ja.nx.link

{
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "description": "Request to purchase a product. The system will automatically use your wallet balance to purchase the specified product.",
          "examples": [
            {
              "from": "0xEfc38EF8C09535b25e364b6d1a7C406D3972f2A9"
            }
          ],
          "properties": {
            "from": {
              "description": "The wallet address or ENS name that will purchase the product. If omitted, the project wallet will be used if available.",
              "type": "string"
            }
          },
          "title": "Purchase Product Request",
          "type": "object"
        }
      }
    }
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "result": {
                "properties": {
                  "transactionId": {
                    "description": "Transaction ID that was executed for your product purchase",
                    "type": "string"
                  }
                },
                "required": [
                  "transactionId"
                ],
                "type": "object"
              }
            },
            "required": [
              "result"
            ],
            "type": "object"
          }
        }
      },
      "description": "Product purchased successfully. Returns the transaction used for the purchase."
    },
    "400": {
      "description": "Invalid request parameters."
    },
    "401": {
      "description": "Authentication required. For backend usage, include `x-secret-key` header. For frontend usage, include `x-client-id` + `Authorization: Bearer <jwt>` headers."
    },
    "402": {
      "content": {
        "application/json": {
          "schema": {
            "description": "Payment required response when user has insufficient funds. Contains a quote for completing the purchase.",
            "properties": {
              "result": {
                "properties": {
                  "id": {
                    "description": "Payment ID",
                    "type": "string"
                  },
                  "link": {
                    "description": "Link to purchase the product",
                    "type": "string"
                  },
                  "message": {
                    "description": "Message to display to the user",
                    "type": "string"
                  },
                  "quote": {
                    "description": "Bridge quote for completing the payment",
                    "properties": {
                      "blockNumber": {
                        "description": "Block number when quote was generated",
                        "type": "string"
                      },
                      "destinationAmount": {
                        "description": "Destination amount in wei",
                        "type": "string"
                      },
                      "estimatedExecutionTimeMs": {
                        "description": "Estimated execution time in milliseconds",
                        "type": "number"
                      },
                      "intent": {
                        "description": "Quote intent details",
                        "properties": {
                          "amount": {
                            "description": "The amount in wei",
                            "type": "string"
                          },
                          "destinationChainId": {
                            "description": "Destination chain ID",
                            "exclusiveMinimum": 0,
                            "type": "integer"
                          },
                          "destinationTokenAddress": {
                            "description": "Destination token address",
                            "type": "string"
                          },
                          "originChainId": {
                            "description": "Origin chain ID",
                            "exclusiveMinimum": 0,
                            "type": "integer"
                          },
                          "originTokenAddress": {
                            "description": "Origin token address",
                            "type": "string"
                          },
                          "receiver": {
                            "description": "Receiver address",
                            "type": "string"
                          },
                          "sender": {
                            "description": "Sender address",
                            "type": "string"
                          }
                        },
                        "required": [
                          "amount",
                          "destinationChainId",
                          "destinationTokenAddress",
                          "originChainId",
                          "originTokenAddress",
                          "receiver",
                          "sender"
                        ],
                        "type": "object"
                      },
                      "originAmount": {
                        "description": "Origin amount in wei",
                        "type": "string"
                      },
                      "steps": {
                        "description": "Array of steps to complete the bridge operation",
                        "items": {
                          "properties": {
                            "destinationAmount": {
                              "description": "Destination amount in wei",
                              "type": "string"
                            },
                            "destinationToken": {
                              "description": "Destination token information",
                              "properties": {
                                "address": {
                                  "description": "A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth).",
                                  "type": "string"
                                },
                                "chainId": {
                                  "description": "The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism).",
                                  "examples": [
                                    1,
                                    8453,
                                    137,
                                    56,
                                    43114,
                                    42161,
                                    10
                                  ],
                                  "exclusiveMinimum": 0,
                                  "type": "integer"
                                },
                                "decimals": {
                                  "type": "number"
                                },
                                "iconUri": {
                                  "type": "string"
                                },
                                "prices": {
                                  "additionalProperties": {
                                    "type": "number"
                                  },
                                  "description": "Token price in different FIAT currencies.",
                                  "examples": [
                                    {
                                      "EUR": 0.84,
                                      "USD": 1
                                    }
                                  ],
                                  "type": "object"
                                },
                                "symbol": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "chainId",
                                "address",
                                "decimals",
                                "symbol",
                                "prices"
                              ],
                              "type": "object"
                            },
                            "estimatedExecutionTimeMs": {
                              "description": "Estimated execution time in milliseconds",
                              "type": "number"
                            },
                            "originAmount": {
                              "description": "Origin amount in wei",
                              "type": "string"
                            },
                            "originToken": {
                              "description": "Origin token information",
                              "properties": {
                                "address": {
                                  "description": "A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth).",
                                  "type": "string"
                                },
                                "chainId": {
                                  "description": "The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism).",
                                  "examples": [
                                    1,
                                    8453,
                                    137,
                                    56,
                                    43114,
                                    42161,
                                    10
                                  ],
                                  "exclusiveMinimum": 0,
                                  "type": "integer"
                                },
                                "decimals": {
                                  "type": "number"
                                },
                                "iconUri": {
                                  "type": "string"
                                },
                                "prices": {
                                  "additionalProperties": {
                                    "type": "number"
                                  },
                                  "description": "Token price in different FIAT currencies.",
                                  "examples": [
                                    {
                                      "EUR": 0.84,
                                      "USD": 1
                                    }
                                  ],
                                  "type": "object"
                                },
                                "symbol": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "chainId",
                                "address",
                                "decimals",
                                "symbol",
                                "prices"
                              ],
                              "type": "object"
                            },
                            "transactions": {
                              "description": "Array of transactions for this step",
                              "items": {
                                "properties": {
                                  "action": {
                                    "description": "Type of action this transaction performs",
                                    "enum": [
                                      "approval",
                                      "transfer",
                                      "buy",
                                      "sell",
                                      "fee"
                                    ],
                                    "type": "string"
                                  },
                                  "chainId": {
                                    "description": "Blockchain network identifier",
                                    "exclusiveMinimum": 0,
                                    "type": "integer"
                                  },
                                  "data": {
                                    "description": "Transaction data payload",
                                    "type": "string"
                                  },
                                  "from": {
                                    "description": "Transaction sender address",
                                    "type": "string"
                                  },
                                  "spender": {
                                    "description": "Spender address for approval transactions",
                                    "type": "string"
                                  },
                                  "to": {
                                    "description": "Transaction recipient address",
                                    "type": "string"
                                  },
                                  "value": {
                                    "description": "Transaction value in wei",
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "chainId",
                                  "to",
                                  "data",
                                  "action"
                                ],
                                "type": "object"
                              },
                              "type": "array"
                            }
                          },
                          "required": [
                            "originToken",
                            "destinationToken",
                            "transactions",
                            "originAmount",
                            "destinationAmount"
                          ],
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "timestamp": {
                        "description": "Quote timestamp",
                        "type": "number"
                      }
                    },
                    "required": [
                      "destinationAmount",
                      "intent",
                      "originAmount",
                      "steps",
                      "timestamp"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "message",
                  "link"
                ],
                "type": "object"
              }
            },
            "required": [
              "result"
            ],
            "title": "Payment Required Response",
            "type": "object"
          }
        }
      },
      "description": "Payment required. Insufficient wallet balance to complete the purchase."
    },
    "500": {
      "description": "Internal server error. This may occur due to network connectivity issues, wallet creation failures, or transaction execution failures."
    }
  }
}