To retrieve payment with Link and QR Code; you can create a link on Craftgate, share this link or QR code and you can easily retrieve payment without the need for any technical integration.

Create Link

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

URL

POST/craftlink/v1/products

Request Parameters

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

name

string

required

Name of the product

description

string

required

It can be used to show the details of the link you want to create. You can put the part you want to make bold text between ** signs, for example; ** Text **. In the description section, you can add \n at the end of each line to make it go to the bottom line.

orderId

string

Order Id to be send to bank. Stock value should be 1 if order id presents.

price

number

required

Price

currency

Currency

required

Currency. See: Currencies

Values:

TRY

USD

EUR

GBP

CNY

ARS

BRL

AED

IQD

AZN

KZT

KWD

SAR

BHD

RUB

JPY

EGP

stock

number

Stock if any.

channel

string

Payment channel

multiPayment

boolean

Indicates that payment will be made in multiple steps.

enabledInstallments

number[]

required

Indicates the installments to be shown in the payment step.

Response Parameters

The parameters returned as a result of the link creation are 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 product link

name

string

Name of the product

description

string

Description of the product

channel

string

Payment channel

orderId

string

Bank Order Id

status

Status

Status of the link

Values:

ACTIVE

PASSIVE

price

number

Price

currency

Currency

Currency. See: Currencies

Values:

TRY

USD

EUR

GBP

CNY

ARS

BRL

AED

IQD

AZN

KZT

KWD

SAR

BHD

RUB

JPY

EGP

stock

number

Stock.

soldCount

number

Indicates how many times the payment is received via the link.

token

string

Token of the product link

multiPayment

boolean

Indicates that payment will be made in multiple steps.

enabledInstallments

number[]

Indicates the installments to be shown in the payment step.

url

string

URL

qrCodeUrl

string

QR code URL.

Sample Codes

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

Java.NETPHPNode.jsGo

Update Link

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

URL

PUT/craftlink/v1/products/:id

id

number

required

ID of the product link

Request Parameters

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

status

Status

required

Status of the link

Values:

ACTIVE

PASSIVE

name

string

required

Name of the product

description

string

required

Description of the product

orderId

string

Order Id to be send to bank. Stock value should be 1 if order id presents.

price

number

required

Price

currency

Currency

required

Currency. See: Currencies

Values:

TRY

USD

EUR

GBP

CNY

ARS

BRL

AED

IQD

AZN

KZT

KWD

SAR

BHD

RUB

JPY

EGP

stock

number

Stock if any.

channel

string

required

Payment channel

enabledInstallments

number[]

required

Indicates the installments to be shown in the payment step.

Response Parameters

The parameters returned as a result of the link update are 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:

You can refer to the link response for the return value.

Sample Codes

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

Java.NETPHPNode.jsGo

Retrieve Link

The endpoint and http method information to retrieve link are stated below.

URL

GET/craftlink/v1/products/:id

id

number

required

ID of the product link

Response Parameters

The parameters returned as a result of the link inquiry are 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:

You can refer to the link response for the return value.

Sample Codes

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

Java.NETPHPNode.jsGo

Delete Link

The endpoint and http method information to delete link are stated below.

URL

DELETE/craftlink/v1/products/:id

id

number

required

ID of the product link

Sample Codes

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

Java.NETPHPNode.jsGo

Search Links

The endpoint and http method information to search links are stated below.

URL

GET/craftlink/v1/products

name

string

Name of the product link

minPrice

number

Min price

maxPrice

number

Max price

currency

Currency

Currency. See: Currencies

Values:

TRY

USD

EUR

GBP

CNY

ARS

BRL

AED

IQD

AZN

KZT

KWD

SAR

BHD

RUB

JPY

EGP

channel

string

Payment channel

page

number

Start index of the search result

size

number

Size of the search result

Response Parameters

The parameters returned as a result of the link search are 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:

page

number

Start index of the search result

size

string

Size of the search result

totalSize

string

Total size of the search result

items

Link[]

List of product links. You can refer to the link response for the return value.

Sample Codes

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

Java.NETPHPNode.jsGo