URL
| HTTP Method | URL |
|---|
POST | /tokenlink/v1/products |
Send the merchantId header. The endpoint accepts both application/json and multipart/form-data; use multipart when uploading an image. A successful request returns 201 Created.
Request Parameters
| Parameter | Type | Required / Always Present | Description |
|---|
name | string | Yes | Payment-link name; 1–255 characters. |
description | string | No | Description displayed on the payment page; maximum 255 characters. |
price | decimal | No | Positive payment amount with at most two fractional digits. |
stock | integer | No | Available stock count. |
expireDate | date-time | No | Future ISO date-time after which the link expires. |
enabledInstallments | string | No | Comma-separated installment options, for example 1,2,3,6. |
subMerchantId | long | No | Sub-merchant identifier. |
paymentGroup | PaymentGroup | No | Payment group. |
subMerchantPrice | decimal | No | Amount allocated to the sub-merchant. |
conversationId | string | No | Merchant correlation value. |
enabledBanks | string | No | Allowed bank identifiers. |
posType | PosBlockageResolveType | No | POS blockage resolution type. |
externalId | string | No | External record identifier. |
subExternalId | string | No | External sub-record identifier. |
externalProductUniqueId | string | No | External unique product identifier. |
enabledInstForCommercial | string | No | Commercial-card installment options. |
kvkkUrl | string | No | Privacy notice URL. |
paymentDocumentType | string | No | Payment document type. |
merchantBranchName | string | No | Merchant branch name. |
paymentPhase | PaymentPhase | No | Payment phase; defaults to AUTH. |
currency | Currency | No | Payment currency. |
items | PaymentItem[] | No | Payment breakdown; maximum 250 entries. |
language | string | No | Payment-page language. |
productSpecificationType | ProductSpecificationType | No | Product specification type. |
chippinPhoneNumber | string | No | Phone number used by the Chippin flow. |
linkType | LinkType | No | Payment-link type. |
rapidUserId | string | No | Rapid user identifier. |
chippinBranchType | string | No | Chippin branch type. |
merchantUserEmail | string | No | Merchant user email address. |
customerEmail | string | No | Customer email address. |
customerPhone | string | No | Customer phone number. |
autoPostAuthDateCount | string | No | Automatic post-authorization date count. |
exchangePrice | string | No | Exchange-price value. |
taxNumber | string | No | Customer tax number. |
makeReceiptQueryEnabled | boolean | No | Enables receipt queries; defaults to false. |
specificDistribution | boolean | No | Enables specific distribution; defaults to false. |
Response Parameters
The returned object is placed in the standard data response field.
| Parameter | Type | Required / Always Present | Description |
|---|
id | long | Yes | Payment-link identifier. |
status | Status | Yes | Link status; a newly created link is ACTIVE. |
token | string | Yes | Unique payment-link token. |
url | string | Yes | Shareable payment URL. |
qrCodeUrl | string | No | QR-code URL; omitted for CREDIT links. |
name | string | No | Payment-link name. |
description | string | No | Payment-link description. |
price | decimal | No | Payment-link amount. |
stock | integer | No | Available stock count. |
soldCount | integer | No | Number of completed sales. |
enabledInstallments | string | No | Enabled installment options. |
expireDate | date-time | No | Expiration date and time. |
paymentIdList | long[] | No | Identifiers of payments made through the link. |
paymentPhase | PaymentPhase | No | Payment phase. |