Create Member

The endpoint and http method information to create members are stated below.

Members can be of three different types:

  • Buyer
  • Sub-merchant (used in Marketplace solution)
  • Buyer Featured Sub-merchant (Both Buyer and Seller) (used in Marketplace solution)

URL

HTTP Method URL
POST /onboarding/v1/members

Request Parameters

The parameters expected to be sent in requests to create a new member are listed under the table and subheadings below.

Parameter Name Type Required Description
isBuyer boolean No Set this parameter true if member is a buyer
isSubMerchant boolean No Set this parameter true if member is a seller
memberType MemberType No Member type. Required if member is a seller. See: Member Types
memberExternalId string Yes External id of the member
name string No Name of the member. Required if member is a seller and has limited/joint stock company
address string Yes Address of the member
email string Yes E-mail address of the member
iban string No Member IBAN. Required if member is a seller and settlementEarningsDestination parameter is IBAN
settlementEarningsDestination SettlementEarningsDestination No Settlement earning destination of the member. Required if member is a seller. See: Payout Destinations
negativeWalletAmountLimit decimal No Member negative wallet amount limit that should be negative
phoneNumber string Yes Phone number of the member
legalCompanyTitle string No Legal company title of the member's company. Required if member is a seller and has limited/joint stock company
taxOffice string No Tax office of the member's company. Required if member is a seller and has limited/joint stock company
taxNumber string No Tax number of the member's company. Required if member is a seller and has limited/joint stock company
contactName string No Contact name of the member. Required if member is a buyer or is a seller and has personal or private company
contactSurname string No Contact surname of the member. Required if member is a buyer or is a seller and has personal or private company
identityNumber string No Identity number of the member

Response Parameters

Parameters returned as a result of member creation 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 member
createdDate date The date that the member is created
updatedDate date The date that the member is updated
status Status Member status. See: Status
isBuyer boolean Returns true if member is a buyer
isSubMerchant boolean Returns true if member is a seller
memberType MemberType Member type. See: Member Types
memberExternalId string External id of the member
name string Name of the member
address string Address information of the member
email string E-mail address of the member
phoneNumber string Phone number of the member
identityNumber string Identity number of the member
contactName string Contact name of the member
contactSurname string Contact surname of the member
legalCompanyTitle string Legal company title of member's company
taxOffice string Tax office of the member's company
taxNumber string Tax number of the member's company
settlementEarningsDestination SettlementEarningsDestination Settlement earning destination of the member. See: Payout Destinations
negativeWalletAmountLimit decimal Negative wallet amount limit for member's wallet
iban string Member IBAN

Sample Codes

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

Buyer Creation

Sub-merchant Creation (for Marketplace solution)

Buyer Featured Sub-merchant Creation (for Marketplace solution)