mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-05 21:35:49 +00:00
31 lines
979 B
Plaintext
31 lines
979 B
Plaintext
## prepareCheckCash
|
|
|
|
`prepareCheckCash(address: string, checkCash: object, instructions: object): Promise<object>`
|
|
|
|
Prepare a Check cashing transaction. This redeems a Check to receive up to the amount authorized by the corresponding CheckCreate transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema('input/prepare-check-cash.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 checkCash = <%- importFile('test/fixtures/requests/prepare-check-cash-amount.json') %>;
|
|
return api.prepareCheckCash(address, checkCash).then(prepared =>
|
|
{/* ... */});
|
|
```
|
|
|
|
<%- renderFixture('responses/prepare-check-cash-amount.json') %>
|