mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-04-29 15:37:50 +00:00
31 lines
832 B
Plaintext
31 lines
832 B
Plaintext
## preparePayment
|
|
|
|
`preparePayment(address: string, payment: Object, instructions: Object): Promise<Object>`
|
|
|
|
Prepare a payment transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema("input/prepare-payment.json") %>
|
|
|
|
### Return Value
|
|
|
|
This method returns a promise that resolves with an object with the following structure:
|
|
|
|
<aside class="notice">
|
|
All "prepare*" methods have the same return type.
|
|
</aside>
|
|
|
|
<%- renderSchema("output/prepare.json") %>
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
|
|
const payment = <%- importFile('test/fixtures/requests/prepare-payment.json') %>;
|
|
return api.preparePayment(address, payment).then(prepared =>
|
|
{/* ... */});
|
|
```
|
|
|
|
<%- renderFixture("responses/prepare-payment.json") %>
|