1. Create Member

Create Member

POST {{MemberBaseAddress}}/api/paywall/member

Important: In order to use the member service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.

MemberAPI Address

Parameter
Type
Compulsory
Description

apikeypublic

string

Yes

The Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client obtained from the member business panel.

The parameters that need to be sent to the service are as follows:

Parameter
Type
Compulsory
Description

IsSubMerchant

boolean

Yes

Is the added member a sub-member business?

MemberType

int

Yes/No

The merchant type is a required field if the IsSubMerchant parameter is sent as true. See: Merchant Types

MemberExternalId

string

Yes

The Id information of the member in your system.

MemberName

string

Yes

The nickname provided to the member by your side.

MemberTitle

string

Yes

The real name of the member.

Company: Title Individual: First Name Last Name

MemberTaxOffice

string

Yes/No

The tax office of the member. Mandatory if the member is of type company.

MemberTaxNumber

string

Yes/No

The tax number of the member. Mandatory if the member is of type company.

MemberIdentityNumber

string

Yes/No

The ID number of the member. Mandatory if the member is an individual or a sole proprietorship.

MemberEmail

string

Yes

The email address of the member.

MemberPhone

string

Yes

The phone number of the member.

MemberAddress

string

Yes

The address of the member.

ContactName

string

Yes

The contact name of the member. Mandatory if the member is an individual or a sole proprietorship.

ContactLastname

string

Yes

The contact name of the member. Mandatory if the member is an individual or a sole proprietorship.

BankAccounts

BankAccount

No

If you want to define the member's bank information during member registration, you can use the object example below.

ValueDate

ValueDate

No

If you want to define the member's value date/commission settings during member registration, you can use the object example below.

BankAccount Object:

Parameter
Type
Compulsory
Description

CurrencyId

int

Yes

Indicates the currency of the member business's bank account.

Title

string

Yes

The name of the member business's bank account. Used for fund transfers, certain and accurate in its entirety olmalıdır.

Iban

string

Yes

The IBAN information of the member business's bank account.

ValueDate Object:

Parameter
Type
Compulsory
Description

CalculationType

int

Yes

Specifies the interval type for calculating the member business's earnings. You can find more detailed information from system data.

1 = PlusDay 2 = ADayOfWeek 3 = ADayOfMonth

CalculationValue

int

Yes

The value indicating the interval at which the member business will receive its earnings. This value varies depending on the type of interval.

1 then (1-100) between 2 then (1-7) between 3 then (1-28) between

Commission

decimal

Yes

The commission percentage to be taken from the sub-member business is specified; when calculating earnings, a percentage is deducted from the sub-member business, up to the specified amount. "The purchase is 100TL, your commission is 10%, and at the end of the day, the member business receives 90TL, and you receive 10TL.

( The payment provider's commission will be deducted) It will be credited to your account

Sample to be sent to the service JSON and sample codes is as follows

{
    "IsSubMerchant": true,
    "MemberType": 1,
    "MemberExternalId": "111aa11135552244413",
    "MemberName": "Intranet Technology",
    "MemberTitle": "Intranet Technology Yazılım A.S",
    "MemberTaxOffice": "Besiktas",
    "MemberTaxNumber": "4651176935",
    "MemberIdentityNumber": "11111111110",
    "MemberEmail": "[email protected]",
    "MemberPhone": "5554443322",
    "MemberAddress": "test adresi",
    "ContactName": "Member Name",
    "ContactLastname": "Lastname",
    "BankAccounts": [
        {
            "CurrencyId": 1,
            "Title": "Ünvan",
            "Iban": "TR370006400012345678987654"
        }
    ],
    "ValueDate": {
        "CalculationType": 1,
        "CalculationValue": 10,
        "Commission": 10   
    }
}

The parameters returned from the service are as follows:

Parameter
Type
Description

ErrorCode

int

Error code. It returns '0' if the transaction is successful.

Result

bool

It returns either true or false. If the transaction is successful, it returns 'true'.

Message

string

If the transaction is erroneous, this is the specified error message, providing language support based on the 'locale' parameter.

Body

object

Transaction details

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 15,
        "IsSubMerchant": true,
        "MemberType": 1,
        "MemberExternalId": "111aa11135552244413",
        "MemberName": "Intranet Technology",
        "MemberTitle": "Intranet Technology Yazılım A.S",
        "MemberTaxOffice": "Besiktas",
        "MemberTaxNumber": "*6*1*7*9*5",
        "MemberIdentityNumber": "",
        "MemberEmail": "[email protected]",
        "MemberPhone": "5554443322",
        "MemberAddress": "test adresi",
        "ContactName": "Member Name",
        "ContactLastname": "Lastname",
        "InsertDateTime": "2023-06-29T15:32:52.570869+03:00"
    }
}

Last updated