Documentation

Logging in

The first step to using this site is to log in. The login page asks for a web address, which is a url that should represent you and that supports the Indieauth protocol. When you log in, indiepay.me will also check if your site supports the Micropub protocol. If it does, it will use that information to automatically create payment posts on your site. If Micropub isn't supported, the contents of the post will be displayed on the page so that you can manually add the post on your own site.

Creating a payment post

Before creating a post you need to pick someone to start a transaction with. So once you've logged in, you will be asked for a web address. indiepay.me will check that the address you've provided represents a person, and if they receive homepage webmentions. That information is important, because the payment post is going to include a person-tag for the recipient, and your site should send a webmention to that address once the post is created. Without this notification, the recipient won't know that you've initiated a payment transaction with them.

Format of the post

The created post can be identified as a payment post because it contains a number of microformats properties. The first property to add is either debit or credit, depending on the type of post you want to create. This property should have a value that is the amount of the transaction, and should always be greater than zero. The post should also have a person tag for each recipient of the post.

Your site should send webmentions to the recipients, and you can also add a link to indiepay.me and send a webmention here too. That way indiepay.me will check the post, and store a copy here to track your payment history.

Payment post example:
<div class="p-name e-content">
  Payment of <data class="p-credit" value="2.43">$2.43</data> requested from
  <a class="u-category h-card" href="https://unicyclic.com/mal">Malcolm Blaney</a>
</div>
<a href="https://indiepay.me">indiepay.me</a>

Replies also need to have a debit or credit property, but it must be the opposite of the post it's replying to. The value of this property must also match the value in the original post. They will also need to have an in-reply-to property with a value that matches the post, and the author of the reply must be listed as a recipient in the original post. The reply can also contain a link to indiepay.me so that it gets tracked here, but it's not required if the original post supports salmentions.

Payment reply example:
<div class="p-name e-content">
  Payment request of <data class="p-debit" value="2.43">$2.43</data> accepted.
  <a href="https://unicyclic.com/mal/example-post" class="u-in-reply-to"></a>
</div>

Tracking payment posts

If the post or reply matches the format mentioned, indiepay.me will store a copy and update the transaction history for the author. If you reply to a payment post that doesn't link to indiepay.me, you can still have it tracked here! Just add a link to indiepay.me to your reply, and this site will fetch the original post. Anyone can log in to the site to view their history recorded here.

Once a reply to a post stored on indiepay.me has also been received, this site will record the payment as confirmed and update the balance between the two authors. When you log in and enter someone's web address, indiepay.me will give you the balance between yourself and the other person.

indiepay.me is also a custom reader that just shows you payment posts. When a payment is made to you (or requested from you), the post will show up in your feed. It will also give you a reply link, so you can confirm the payment from here too. But that's probably enough information! The easiest way to see how it works is just to log in and have a go.