Guides

Register in the directory

Register a payee record so owners can find your API, and start the count of what you settle.

The directory lists every registered payee with what it sells and its standing. Owners pick the payees a remit may pay from it. Registering puts your API there and starts your counts: payments settled and payments refunded.

You need the payee's wallet, set up with a private balance: Deposit and withdraw a private balance. It is the same key your gate is paid at.

  1. Open Earn

    Go to Earn with the payee's wallet. An unregistered wallet sees the form Your directory record.

  2. Fill in the record

    FieldWhat to enter
    NameWhat agents and owners will see. Up to 64 characters.
    URLThe address of the API, starting with https://. Up to 200 characters.
    What it sellsOne or two sentences. Up to 280 characters.
    Paid inThe mint you price in, when the app offers more than one.
    Price hintWhat one call usually costs.

    The price hint tells an owner what to expect when setting a remit's caps. The price of a call is whatever your gate asks for it.

  3. Press Register

    Approve the transaction. The line moves through Building, Signing, Sending and Confirmed.

Earn now shows your record, four tiles (Private balance, Holds waiting, Settled, Refunded) and the gate snippet. Your page is live at /directory/<your address>, and the name links to it from the top of Earn.

Everything in the record is public: the name, the URL, what you sell, the price hint and the mint.

Edit the record

Press Edit the record, change the fields, and press Save the record. Your standing is untouched: the counts belong to the address, not to what the record says.

What owners see

On the directory your row shows the name and URL, what you sell, the price hint, the settled and refunded counts and the date of your first settlement. Owners sort by Most settled, Fewest refunds, Newest or Name, and search names, URLs and descriptions.

Your own page adds your settled and refunded payments per day over the last 30 days, and the line an owner copies to allow a remit to pay you:

TypeScript
payees: ['<your address>']

In the app, an owner ticks your row when opening a remit.

How standing grows

Each hold your gate settles adds one to Settled. Each hold that passes its deadline unsettled adds one to Refunded. Nothing else changes either count, and they cannot be edited. Payments made to your address before you registered are not counted.

With the SDK

TypeScript
import { createOwner } from '@remit/sdk'

const payee = createOwner({ keys: process.env.REMIT_PAYEE_KEY! })

await payee.registerPayee({
  name: 'Example Quotes',
  url: 'https://api.example.com/quote',
  description: 'Live bid and ask for Solana pairs, one pair per call.',
  priceHint: '40000',
  mint: process.env.MINT!,
})

updatePayee takes the same fields and rewrites the record.

Loading the index