Skip to main content

Payment proof methods

Endpoint
http://127.0.0.1:3420/v3/owner
Credential
Token from open_wallet, inside the encrypted envelope. Loopback only
Methods here
4
Documented against
node 4.0.3, wallet 4.0.0

retrieve_payment_proof

Read only

The proof for a completed transfer.

Surface
/v3/owner on port 3420
Parameters
4 named
Declared in
api/src/owner_rpc_s.rs:2110
  • A transfer that travelled over epicbox has no proof to retrieve. That transport carries slate V2, and the conversion drops the proof fields.
Parameters

Session token. Every method on this surface needs it.

Refresh first.

Transaction log id.

Slate uuid.

11 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "retrieve_payment_proof",
  "params": {
    "token": "<token from open_wallet>",
    "refresh_from_node": true,
    "tx_id": null,
    "tx_slate_id": null
  }
}
Response
N/A

verify_payment_proof

Read only

Check a proof against this wallet.

Surface
/v3/owner on port 3420
Parameters
2 named
Declared in
api/src/owner_rpc_s.rs:2157
  • Returns a two-element array of booleans.
Parameters

Session token. Every method on this surface needs it.

The proof object.

9 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "verify_payment_proof",
  "params": {
    "token": "<token from open_wallet>",
    "proof": {}
  }
}
Response
N/A

proof_address_from_onion_v3

Read only

Convert an onion address into a proof address.

Surface
/v3/owner on port 3420
Parameters
1 named
Declared in
api/src/owner_rpc_s.rs:2070
Parameters

An onion v3 address.

8 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "proof_address_from_onion_v3",
  "params": {
    "address_v3": "<onion address>"
  }
}
Response
N/A

verify_slate_messages

Read only

Check the signatures on the messages attached to a slate.

Surface
/v3/owner on port 3420
Parameters
2 named
Declared in
api/src/owner_rpc_s.rs:1366
Parameters

Session token. Every method on this surface needs it.

The slate to check.

9 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "verify_slate_messages",
  "params": {
    "token": "<token from open_wallet>",
    "slate": {}
  }
}
Response
N/A

Next​

Payment proofs

What a proof establishes, and what it does not.

Transports

Arranging delivery so there is a proof to retrieve.