Get started

Protected Pay API

Add protected payments to your checkout: your server creates a payment intent, the buyer pays it from their own wallet, and you follow the outcome by API or webhook.

How an integration works

  1. Your server creates a payment intent: recipient, amount, asset, and protection period. It moves no money.
  2. The buyer pays the intent from their own wallet. The quickest way is the hosted checkout: send the buyer to the intent’s checkoutUrl.
  3. The payment is held for the protection period in a vault for that payment alone. It settles to the recipient, or is refunded to the buyer if a dispute ends that way.
  4. Your server follows it through the API and signed webhooks, and fulfils the order when it is released.

Your API key, your intents, and the dashboard cannot move, redirect, or hold funds. Funds enter a payment’s vault only when the buyer signs, and leave it only under the protocol’s rules: to the recipient, less the merchant settlement fee, or back to the buyer in full.

Before you start

You need a Protected Pay business account. API keys and webhook endpoints are managed in its dashboard. Environments lists the network and asset your keys operate on.

Where to go next

  • Quickstart: from an API key to your first protected payment.
  • Payment intents: the object your integration revolves around.
  • API basics: authentication, errors, idempotency, and pagination.
  • Webhooks: signed events delivered to your server.