Receipts

The exact text to sign for a report that has not been written yet.

Returns the statement to sign with the reporting address, together with the hash it commits to. Needed because the hash depends on the tip of that side's chain, which only the server knows. Writes nothing: asking what a report would hash to is not reporting it. The result is signed with personal_sign — a message signature, never a transaction. It moves no funds and authorises nothing else.

post/v1/receipts/signing-message

Request

  • Base URL: https://api.fidren.net
  • URL: https://api.fidren.net/v1/receipts/signing-message
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

operation_idstring required
addressstring required

The reporting address — this side's own address. A signature, if given, must be produced by it.

chain'base' | 'polygon' required
side'PAYER' | 'PAYEE' required

Which end of the operation is reporting. Each side keeps its own hash chain, and the two accounts are compared rather than merged.

counterparty_addressstring nullable

The other end, as this reporter names it.

status'REQUESTED' | 'ACCEPTED' | 'DELIVERED' | 'CONCLUDED' | 'FAILED' | 'DISPUTED' | 'REFUNDED' required
signaturestring

Optional 65-byte personal_sign signature over the statement returned by POST /v1/receipts/signing-message. Stored only if it verifies against address; an unverifiable one is reported back and the receipt is recorded without it.

amount_centsinteger nullable
currencystring
tx_hashstring nullable
occurred_atstring date-time required

Response

The statement to sign.

messagestring required
hashstring required
prev_hashstring nullable required
instructionsstring required

Changes

No recorded changes to this operation across all 1 revision of this API.