Guides

Read a statement

Open a remit's page to read what it holds, its terms and every payment its agent has made.

A remit's statement is the list of every payment its agent has made, with the payee, the amount, the request and the status of each. It is encrypted on chain. Only the wallet that opened the remit reads it.

  1. Open your remits

    Go to the app with the wallet that opened the remit, and sign to derive the keys if the tab asks. Your remits lists each remit with its agent, what remains, what was spent today, when it expires and its status.

  2. Open the remit

    Press its row. The page takes a moment on "Decrypting this remit".

  3. Read the figures

    Remaining is what the remit holds, out of what it was opened with. The tiles show the cap per payment, what was spent today against the cap per day, what was spent in all, and the expiry with its date in UTC.

  4. Read the statement

    Each row is one payment, newest first.

The columns

ColumnWhat it shows
TimeWhen the agent paid.
PayeeThe payee's name from the directory and its address.
RequestThe URL that was paid for, or the request's hash.
AmountThe price paid.
Statusheld, settled or refunded.
ReceiptDisclose, which copies a link to this one payment.

A payment appears as held the moment the agent pays. It turns settled when the payee delivers and takes the hold, usually seconds later. It turns refunded if the payee has not settled by the hold's deadline, and the amount is then back in your private balance.

Spent today counts every payment made in the current UTC day, refunded ones included. Spent in all leaves refunded payments out.

A remit's status

StatusMeaning
OpenThe agent can pay from it.
SpentNothing is left in it.
ExpiredIts expiry has passed. Revoke it to take back what is left.
RevokedYou closed it.

With the SDK

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

const owner = createOwner({ keys: process.env.OWNER_SECRET_KEY! })

for (const remit of await owner.remits()) {
  console.log(remit.remitId, remit.status, remit.remaining)
}

const remit = await owner.statement('<remit id>')
for (const payment of remit.payments) {
  console.log(payment.paidAt, payment.payee, payment.amount, payment.status)
}

Each payment carries paySignature, payee, amount, mint, requestHash, deadline, paidAt and status, and once settled settleSignature, responseHash, fee and settledAt.

Loading the index