Skip to content

Fiat-Payment-Plan.md

Latest commit

 

History

History
70 lines (51 loc) · 4.31 KB

Fiat-Payment-Plan.md

File metadata and controls

70 lines (51 loc) · 4.31 KB

Fiat Payment Flow

This document describes how an AI Builder can set up a Fiat Payment Flow using Nevermined. This will allow consumers to pay with fiat currency using the integration of an external payment provider (e.g., Stripe, PayPal, etc.) for the execution of requests by AI Agents.

Because the payment in fiat requires direct human interaction (typical browser payment flow), the payment flow (not the usage of the plan or agent requests) is designed to have a human in the loop.

The payment of the payment plan, which happens off-chain, will result in an on-chain settlement and the minting of credits that can be used to pay for requests to the AI Agent.

Flow Diagram

sequenceDiagram
  title Fiat Payment Flow (Plan Registration and Purchase)
  participant subscriber as Subscriber
  participant agent as AI Agent
  participant backend as NVM API
  participant processor as Payment Processor
  participant nvm as Nevermined Protocol

  agent->>backend: 1. Register Agent & Plan (Fiat Plan)
  backend-->>agent: 2. Agent & Plan details

  note over subscriber: 3. Finds the Agent & Plan to use
  subscriber->>backend: 4. Request the purchase of a Plan <br/>(planId)
  backend->>processor: 5. Creates a Payment Intent <br/>(planId, price, etc.)
  processor-->>backend: 6. Payment Intent details <br/>(paymentIntentId)
  backend-->>subscriber: 7. Payment details <br/>(payment link, paymentIntentId)

  note over subscriber: 8. Payment link is opened and is completed<br/> in the subscriber's browser
  subscriber->>processor: 9. Completes the payment

  processor-->>backend: 10. Payment confirmed <br/>(webhook)
  note over backend: 11. Payment validation
  backend->>nvm: 12. Call Fiat Plan template (order)
  note over nvm: 13. Settlement & <br/>distribution of credits to Subscriber
  nvm-->>backend: 14. TxHash
  backend-->>subscriber: 15. Payment settled (TxHash, agreementId)
Loading

Steps:

  1. The AI Agent or the owner of the AI Agent requests the NVM API to register a Fiat Payment plan in Nevermined. The plan includes the price in fiat currency and the credits obtained by the purchase. The owner associates the payment plan with the AI Agent.
  2. The NVM API responds with the details of the registered plan, including a unique plan ID and agent ID.
  3. The Subscriber finds the AI Agent and the associated Plan.
  4. The Subscriber requests the NVM API to purchase the Payment Plan.
  5. The NVM API communicates with the Payment Processor (i.e., Stripe). It generates the payment intent including the plan price and the fee.
  6. The Payment Processor returns the payment intent details to the NVM API, including a unique payment intent ID and a payment link (URL) that the Subscriber can use to complete the payment.
  7. The NVM API returns the Payment Intent details to the Subscriber.
  8. The Subscriber opens the payment link in their browser and completes the payment using their preferred payment method (e.g., credit card).
  9. The Subscriber sends the payment information to the Payment Processor to complete the transaction.
  10. The Payment Processor processes the payment and returns the payment status to the NVM API via webhook call.
  11. The NVM API verifies the payment confirmation.
  12. If the payment was successful, the API interacts with the FiatPaymentTemplate.order method to settle the payment.
  13. The NVM Protocol validates the request, settles the payment, and distributes the corresponding credits to the Subscriber.
  14. The NVM Protocol returns a transaction hash (TxHash) to the NVM API as proof of payment.
  15. The NVM API confirms to the AI Agent that the payment has been settled, providing the TxHash and agreementId as proof of payment.

Fiat Payment Template

The Fiat payment flow is implemented using the FiatPaymentTemplate in Nevermined. This template allows capturing the confirmation provided by the Payment Processor, settling the off-chain payment on-chain, and distributing the credits.

NOTE: Because the Payment Processor (e.g., Stripe) doesn't provide a cryptographic proof of payment, the NVM Protocol authorizes settling the payment only to the wallets belonging to the NVM INFRA Role.

To implement this flow, this template involves the following conditions:

  • Fiat Settlement condition: Authorizes the NVM INFRA Role to settle the payment.
  • Credits Distribution condition: Distributes the credits to the Subscriber.