Skip to main content

Update Member

The endpoint and http method information to update member are stated below.

URL

PUT/onboarding/v1/members/:id

Request Parameters

The parameters expected to be sent in requests to update an existing member are listed under the table and subheadings below.

isBuyer
boolean

Set this parameter true if member is a buyer

isSubMerchant
boolean

Set this parameter true if member is a seller

memberType
MemberType

Member type. See: Member Types

Values:
PERSONAL
PRIVATE_COMPANY
LIMITED_OR_JOINT_STOCK_COMPANY
name
string

Name of the member

address
string
required

Address information of the member

email
string
required

E-mail address of the member

phoneNumber
string

Phone number of the member

contactName
string

Contact name of the member

contactSurname
string

Contact surname of the member

legalCompanyTitle
string

Legal company title of the member's company

taxOffice
string

Tax office of the member's company

taxNumber
string

Tax number of the member's company

iban
string

Member IBAN, only TR IBAN should be send

settlementEarningsDestination
SettlementEarningsDestination

Settlement earning destination of the member. See: Payout Destinations

Values:
IBAN
WALLET
CROSS_BORDER
subMerchantMaximumAllowedNegativeBalance
number

Maximum allowed negative balance limit for sub merchant. It will be use if sub merchant balance is not enough for make refund.

Response Parameters

Parameters returned as a result of member update 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 stated in Response Parameters page.

Sample Codes

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

Buyer Update

Loading..

Sub-merchant Update (for Marketplace solution)

Loading..