Skip to main content

Receive Remittance

URL

The endpoint and http method information used to withdraw from member wallet are stated below.

POST/wallet/v1/remittances/receive

Request Parameters

The expected parameters to be sent in requests to withdraw from member wallet are listed under the table and subheadings below.

memberId
number
required

ID of member who own the wallet

price
decimal
required

The amout to be withdraw from wallet

currency
Currency
required

Currency of the wallet

Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
KWD
SAR
BHD
RUB
JPY
EGP
description
string
required

Description

remittanceReasonType
string

Type that indicated the remittance reason. Default value is REDEEM_ONLY_LOYALTY. See: Types of Wallet Transfer/Withdrawal

Values:
REDEEM_ONLY_LOYALTY
Varsayılan:
REDEEM_ONLY_LOYALTY

Response Parameters

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:

id
number

ID of the transaction

createdDate
date

The date that remittance created

status
Status

The status value of the remittance. See: Status

Values:
ACTIVE
PASSIVE
price
decimal

The amount of the remittance

currency
Currency

Currency of the wallet

Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
KWD
SAR
BHD
RUB
JPY
EGP
memberId
number

ID value of the related member

remittanceType
string

Type of the remittance record. SEND: Money Transfer, RECEIVE: Withdraw

Values:
SEND
RECEIVE
remittanceReasonType
string

Type that indicated the remittance reason. see: Types of Wallet Transfer/Withdrawal

Values:
REDEEM_ONLY_LOYALTY
description
string

Description

Sample Codes

You can review the sample codes in the open source Craftgate API clients.

Loading..