Skip to main content

Overview

Recipients are the businesses or individuals you send payments to. When you create a recipient, Teel automatically provisions them across all of your active payment providers, so you can pay them through any available rail. Request bodies are camelCase (businessName, transferType, paymentMethods); responses are snake_case at the top level, with camelCase fields inside nested payment-method objects.

Destination types

A recipient’s transferType sets where their funds land: Whether a stablecoin recipient is paid via a Stablecoin payout (you fund with fiat) or a Crypto payout (you fund with stablecoin) is decided when you execute the payout — not on the recipient.

Step 1: Get recipient requirements

Fetch the fields required to create a recipient, based on your active providers and currencies. The response is a dynamic schema you can render as a form.
The schema adapts to your account — fields and required documents differ by currency and rail. Treat it as the source of truth for what to send in step 3 rather than hard-coding fields.

Step 2: Get wallet networks

If your recipient will receive stablecoins, fetch the supported wallet networks. The response is a JSON array:
Use the name value (e.g. polygon) as the rail on a wallet payment method.

Step 3: Create a recipient

Fiat recipient (bank account)

Stablecoin recipient (wallet)

A recipient can carry multiple payment methods — e.g. wallets on several chains, or a bank account plus a wallet. Add more objects to paymentMethods. Save the id (a UUID) from the response — that’s your recipientId. The Idempotency-Key header is optional but recommended: a timeout-retry with the same key replays the cached response (24h window) instead of creating a duplicate recipient.

Step 4: Auto-provisioning

When a recipient is created, Teel provisions them across all of your active payment providers in the background, so the recipient is ready to receive payments through any rail your providers support — no extra setup needed.

Step 5: Retry failed provisioning

If provisioning fails for a provider (e.g. a transient error), retry it:

Step 6: Get recipient details

Retrieve a recipient with their per-provider counterparty status:

Adding and removing payment methods

You can add payment methods to an existing recipient, or remove one, without recreating the recipient.

Add a payment method

The new payment method is provisioned across your active providers in the background, the same way it is at recipient creation.

Remove a payment method

Both routes require the recipients:write scope.