Payment links

Link paid callback

Sent once to the callback of a payment link when the confirmed deposits seen before it expired cover value less tolerance, in addition to the callback of each deposit. Your URL is called as given, without noncepay_link; every field is in the query string by default, in a form body with post=1, in a JSON body with json=1.

Signed and acknowledged like a payment callback: verify x-ca-signature with the key from /pubkey/ and answer *ok*. Retried until 3 days after the link was paid.

Header Parameters

x-ca-signature*string

Request Body

application/json
  1. body

Fields sent when a payment link is paid, in this order. A link paid in several coins lists paid_coin, paid_amount, exchange_rate and address_in once per coin, comma-separated, in the order first paid.

type?string
link_id?string
Formatuuid
value?string
currency?string
paid_amount_fiat?string

Above value on an overpayment.

paid_coin?string
paid_amount?string
exchange_rate?string

Fiat per coin, averaged over the deposits in that coin.

txids?string

Every deposit counted, comma-separated.

address_in?string
is_paid?string

Response Body

Your server acknowledges with the body *ok*.

response?stringtext/plain
Example Requests
GET/linkPaidCallback

Fields sent when a payment link is paid, in this order. A link paid in several coins lists paid_coin, paid_amount, exchange_rate and address_in once per coin, comma-separated, in the order first paid.

Header Parameters
{  "x-ca-signature": "string"}