The endpoint and http method information used to withdraw from member wallet are stated below.
| HTTP Method | URL |
|---|---|
POST |
/wallet/v1/remittances/receive |
The expected parameters to be sent in requests to withdraw from member wallet are listed under the table and subheadings below.
| Parameter Name | Type | Mandatory | Description |
|---|---|---|---|
memberId |
number |
Yes | ID of member who own the wallet |
price |
decimal |
Yes | The amout to be withdraw from wallet |
currency |
Currency |
Yes | Currency of the wallet |
description |
string |
Yes | Description |
remittanceReasonType |
string |
No | Type that indicated the remittance reason. Default value is REDEEM_ONLY_LOYALTY. See: Types of Wallet Transfer/Withdrawal |
Parameters returned as a result of withdraw from wallet are also subject to the rules specified in
the Response Formats section of the API documentation home page. In the absence of a systematic
or fictional error, the sub-parameters of the object returned in the data parameter are as follows:
| Parameter Name | Type | Description |
|---|---|---|
id |
number |
ID of the transaction |
createdDate |
date |
The date that remittance created |
status |
Status |
The status value of the remittance. See: Status |
price |
decimal |
The amount of the remittance |
currency |
string |
Currency of the wallet |
memberId |
number |
ID value of the related member |
remittanceType |
string |
Type of the remittance record. SEND: Money Transfer, RECEIVE: Withdraw |
remittanceReasonType |
string |
Type that indicated the remittance reason. see: Types of Wallet Transfer/Withdrawal |
description |
string |
Description |
You can review the sample codes in the open source Craftgate API clients.