Create an offer to directly transfer a given amount of Amulet to another party
POST
Wallet API (External)
Create an offer to directly transfer a given amount of Amulet to another party
OpenAPISince 0.5.10
Protocol Details
Inputs
Request body
application/json
string
required
The party id of the receiver.
string
required
The amount of Amulet to transfer.
string
required
An arbitrary, user chosen text. This should be a human readable string that describes the purpose of the transfer. It will be shown to the receiver when they decide whether to accept the offer.
number
required
OpenAPI type:
integer (int64).Expiry time of the transfer offer as unix timestamp in microseconds. After this time, the offer can no longer be accepted and automation in the wallet will eventually expire the transfer offer. Note that this time is compared against the ledger effective time of the Daml transaction accepting or expiring an offer, and can skew from the wall clock time measured on the caller’s machine. See https://docs.daml.com/concepts/time.html for how ledger effective time is bound to the record time of a transaction on a domain.string
required
Tracking id to support exactly once submission. Once submitted, all successive calls with the same tracking id will get rejected with a 409 or 429 status code unless the command fails and the offer did not get created. Clients should create a fresh tracking id when they try to create a new transfer offer. If that command submission fails with a retryable error or the application crashed and got restarted, successive command submissions must reuse the same tracking id to ensure they don’t create the same offer multiple times.
Outputs
200
application/json
string
required
400
application/json
string
required
404
application/json
string
required
409
application/json
string
required
429
application/json
string
required
500
application/json
string
required
History
Introduced
0.5.10