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
Request Parameters
The parameters expected to be sent in requests to create link are listed under the table and subheadings below.
Name of the product
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.
Order Id to be send to bank. Stock value should be 1 if order id presents.
Price
"boomerang" value that can be sent with the request and received with the response. It can be used to associate different requests with each other. Usually, the order number is used that is stored in merchant own system.
It is generally used as a payment order number or basket number on the merchant side. You can search with this value later by using reporting services.
Currency. See: Currencies
Stock if any.
Payment channel
Expiration date of the link. Expected format is 'YYYY-MM-ddTHH:ii:ss'. If not sent, the link will be permanent.
Indicates that payment will be made in multiple steps.
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 of the product link
Name of the product
Description of the product
Payment channel
Bank Order Id
Status of the link
Price
Stock.
Indicates how many times the payment is received via the link.
Token of the product link
Expiration date of the link.
Indicates that payment will be made in multiple steps.
Indicates the installments to be shown in the payment step.
URL
QR code URL.
Sample Codes
You can review the sample codes in the open source Craftgate API clients.
Update Link
The endpoint and http method information to update link are stated below.
URL
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 of the link
Name of the product
Description of the product
Order Id to be send to bank. Stock value should be 1 if order id presents.
Price
Currency. See: Currencies
Stock if any.
Payment channel
Expiration date of the link. Expected format is 'YYYY-MM-ddTHH:ii:ss'. If not sent, the link will be permanent.
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.
Retrieve Link
The endpoint and http method information to retrieve link are stated below.
URL
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.
Delete Link
The endpoint and http method information to delete link are stated below.
URL
ID of the product link
Sample Codes
You can review the sample codes in the open source Craftgate API clients.
Search Links
The endpoint and http method information to search links are stated below.
URL
Request Parameters
The link query can be performed using the parameters below.
Name of the product link
Min price
Max price
Payment channel
Minimum expiration date(YYYY-MM-ddTHH:ii:ss)
Maximum expiration date(YYYY-MM-ddTHH:ii:ss)
Start index of the search result
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:
Start index of the search result
Size of the search result
Total size of the search result
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.