Counterparties

Create a payee link

Makes a one-time link where a vendor or contractor enters the address they are paid at, recorded in the ledger as payee_link_created with via: "api" and the key's id. Send url to the payee yourself. It is in this answer only, since Vestiarion keeps just its hash, and the answer is sent with Cache-Control: no-store. The link works once and expires after 7 days.

The address the payee enters waits for a person in the workspace to confirm it on Counterparties; until then the agent pays nothing to it. Making a link revokes the payee's unused one, so only the newest works. For the same reason this operation keeps no outcome for an Idempotency-Key, which would store the link: a repeat makes a new link. A counterpartyId the workspace does not hold, or a client's, answers 400.

post/api/v1/payee-links

Request

  • Base URL: https://www.vestiarion.xyz
  • URL: https://www.vestiarion.xyz/api/v1/payee-links
  • Auth: HTTP bearer

Request body

counterpartyIdstring required

The id of the vendor or contractor who is to enter the address they are paid at. A client gets no link: the agent never pays one.

Response

Created

Changes

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