Card Minting
This page explains how to sign in to Klip Partners to mint, retrieve, send, and delete Cards using Card Minting API.
Account Management
Account Management consists of Signing In, Changing Password, and Changing PIN.
Sign In
Sign In
POST
https://api.klipwallet.com/v2/partner/auth
After receiving membership approval, signs in to Klip Partners using the email address and password that were used to sign up.
Headers
Name | Type | Description |
---|---|---|
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
email* | string | The email address used to sign up. This will be your account used for signing in. |
password* | string | The password used for signing in. It will be sent as a SHA256 of the password used up sign up. |
Klip Partners is currently accessible only by authorized entities. If your business is considering using the service, please submit via email (1) an introduction of your business, (2) purpose of using Cards, and (3) Card application ideas to klip-partners@groundx.xyz.
Request Example
Response Details
Item | Type | Description |
---|---|---|
string | The email address of the Partner that will be used for signing in. | |
klaytn_address | string | The address of the Partner's Klaytn EOA. |
contract_address | string | The address of the SCA that mints Cards. |
name | string | Legal or registered business name of the Partner. |
phone | string | The phone number of the Partner. |
service_name | string | The name of the BApp provided by the Partner. |
access_token | string | A JWT authentication token issued to enable API requests. |
status | number | Account status code. |
mint_limit | number | The maximum number of Cards that can be issued by the account. |
mint_count | number | The number of Cards actually issued by the account in one month. |
status
will read 20 before the signup approval, and 1 after the approval.
access_token
will expire after 24 hours. mint_count
and mint_limit
will be renewed on the 1st day of each month.
For more details, please refer to our Tuturial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Change Password
Change Password
PUT
https://api.klipwallet.com/v2/partner/?opt=password
Changes the password that was used to sign up.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
old_password* | string | Your old password. |
new_password* | string | Your new password. |
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Change PIN
Change PIN
PUT
https://api.klipwallet.com/v2/partner/pin
Changes the PIN Code.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
old_pin* | string | Your old PIN Code. |
new_pin* | string | Your new PIN Code. |
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Card Management
Card Management consists of Uploading Image, Minting Card To Users, Minting Card To Klip Members, Sending Card To Users, Sending Cards To Klip Member, Getting Card Information By Bapp, Getting Card Information, and Deleting Cards.
Upload Image
Upload Image
POST
https://api.klipwallet.com/v2/wallet/image
Uploads an image to be used for the Card.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | multipart/form-data |
Request Body
Name | Type | Description |
---|---|---|
upload* | string | The file name of the image to be uploaded. Must include file path. |
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Upload NFT Resource
Upload NFT resource
POST
https://api.klipwallet.com/v2/wallet/nftResource
Uploads a resource that will be used for the Cards. A video file for the animation_url
field is limited to 10MiB.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | multipart/form-data |
Request Body
Name | Type | Description |
---|---|---|
upload* | string | The file name of the image to be uploaded. Must include file path. |
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Mint Card to User
Mint Card To User
POST
https://api.klipwallet.com/v2/wallet/mint
Sends user information to Klip Partners and mints Cards. Cards will be minted to EOAs.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that will be used for signing transactions. |
to_address* | array | An array of |
contract_address* | string | The address of the SCA that will mint the Card. |
name* | string | The name of the Cards. |
description* | string | Description of the Cards. |
image* | string | The URL of the image to be used for the Cards. |
animation_url | string | The URL of the video that will be used for the Cards. Supported file extension is |
background_color | string | The RGB color code to be used as the Card's background. |
sendable | boolean | If TRUE, the Cards can be sent from Klip to another account. |
send_friend_only | boolean | If TRUE, the Cards can be sent from Klip only to your friend on KakaoTalk. |
group_name | string | The name of the Card group. |
group_icon | string | The URL of the image to be used as the Card group icon. |
hashtags | array | An array of |
layout | string | Determines how the Cards will be displayed. Square is |
external_link | string | The URL address outside of Klip to which users are redirected. (Max. 255 characters) |
qr_code | string | The image URL with QR Code. (Max. 255 characters) |
bar_code | string | The image URL with Bar Code. (Max. 255 characters) |
attributes | array | An array of |
secure | object | An |
status_url | string | An external URL with the Card's status. This URL must return a JSON object. You can set the required boolean type field |
Request Example
Request Details for secure
Item | Type | Description |
---|---|---|
bar_code | string | The string to be displayed as barcode. It follows the CODE 128 standard. This field is optional. (Max. 20 characters excluding ' '(empty space) or '-') |
qr_code | string | The string to be displayed as QR code. This field is optional. (Max. 255 characters) |
attributes | array | An array of |
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Mint Card to Klip Member
Mint Card To Klip Member
POST
https://api.klipwallet.com/v2/wallet/mint/person
Sends Klip user information to Klip Partners and mints Card. Card will be minted to the EOA of Klip Member based on the name and phone number provided in to_person
.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that is used to sign the transaction. |
to_person* | array | A two-dimensional array containing the name and phone number of the recipient. |
contract_address* | string | SCA address from which the Cards will be minted. |
name* | string | The name of the Cards. |
description* | string | The description of the Cards. |
image* | string | The URL of the image to be used for the Cards. |
animation_url | string | The URL address of the video that will be used for the Cards. Supported file extension is |
background_color | string | The RGB color code to be used as the Card's background. |
sendable | boolean | If TRUE, the Cards can be sent from Klip to another account. |
send_friend_only | boolean | If TRUE, the Cards can be sent from Klip only to your friend on KakaoTalk. |
group_name | string | The name of the Card group. |
group_icon | string | The URL of the image to be used as the Card group icon. |
hashtags | array | An array of |
layout | string | Determines how the Cards will be displayed. Square is |
external_link | string | The URL address outside of Klip to which users are redirected. (Max. 255 characters) |
qr_code | string | The image URL with QR Code. (Max. 255 characters) |
bar_code | string | The image URL with Bar Code. (Max. 255 characters) |
attributes | array | An array of |
secure | object | An |
status_url | string | An external URL containing the Card status. This URL must return a JSON object. You can set the required boolean type field |
Request Example
Request Details for secure
Item | Type | Description |
---|---|---|
bar_code | string | The string to be displayed as barcode. It follows the CODE 128 standard. This field is optional. (Max. 20 characters excluding ' '(empty space) or '-') |
qr_code | string | The string to be displayed as QR code. This field is optional. (Max. 255 characters) |
attributes | array | An array of |
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Get Mint Count
Get Mint Count
GET
https://api.klipwallet.com/v2/wallet/mint/count
Returns the total number of Cards minted using the Partner account. The count is renewed on the 1st day of each month.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Example
Response Details
Item | Type | Description |
---|---|---|
mint_count | number | The number of Cards minted during the month. |
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Send Card to User
Send Card To User
POST
https://api.klipwallet.com/v2/wallet/nft/:nft_id/:card_id/send
Sends Card to other users' EOAs.
Path Parameters
Name | Type | Description |
---|---|---|
nft_id* | string | The ID of the smart contract that minted the Card in the BApp. |
card_id* | string | The ID of the Card in the BApp. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that will be used to sign the transaction. |
to_address* | string | The EOA address of the recipient of the Cards. |
card_name* | string | The name of the Card to send. |
You have to include card_name
so that the Card name appears for the recipient.
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Send Card to Klip Member
Send Card To Klip Member
POST
https://api.klipwallet.com/v2/wallet/nft/:nft_id/:card_id/send/person
Sends Card to Klip Member to the EOA of Klip Member based on the name and phone number provided in to_person
.
Path Parameters
Name | Type | Description |
---|---|---|
nft_id* | string | ID of the smart contract that minted the Cards. |
card_id* | string | The ID of the Card. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that was used to sign the transaction. |
to_person* | array | An array of |
card_name* | string | The name of the Card to send. |
You have to include card_name
so that the Card name appears for the recipient.
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Get Card List
Get Card List
GET
https://api.klipwallet.com/v2/wallet/bapp?cursor=
Returns a list of all your Cards. Cards will be displayed grouped in BApps.
Query Parameters
Name | Type | Description |
---|---|---|
cursor | string | The pointer after which the next request will retrieve the next 100 items if the number of BApps exceeds 100. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Example
Response Details for bapps[i]
;
Item | Type | Description |
---|---|---|
id | number | The ID of the BApp. |
name | string | The name of the BApp. |
bapp_img | string | The address of the BApp image file. |
category_id | number | The ID for the BApp categories. |
nft_order_no | number | The order in which the Card groups are displayed on the Klip Card list. |
summary | string | A one-liner description about the BApp. |
card_count | number | The number of Cards specifically used for this particular BApp. |
nft_id | number | The ID of the NFT. NFT is the smart contract that implements the Card on the blockchain. |
cards | array | An array of |
cards_next_cursor | string | The pointer after which the next request will retrieve the next 100 items if the number of Cards exceeds 100. |
next_cursor | string | The pointer after which the next request will retrieve the next 100 items if the number of BApps exceeds 100. |
Response Details for bapps[i].cards[i]
Item | Type | Description |
---|---|---|
created_at | number | The time at which the Card was minted. |
updated_at | number | The time at which the Card was updated. |
owner | string | The EOA address of the Card owner. |
sender | string | The EOA address of the Card sender. |
card_id | number | The ID of the Card. |
card_uri | string | The URL of the JSON file containing the Card's metadata. |
transaction_hash | string | The transaction hash of the smart contract that minted the Card. |
For more details, please refer to our Card Minting Tutorial-1 and Card Minting Tutorial-2. If you need help with this document or with Klip in general, please visit our Developer Forum.
Get Card Information
Get Card Information
GET
https://api.klipwallet.com/v2/wallet/nft/:nft_id?cursor=
Returns detailed information of your Cards.
Path Parameters
Name | Type | Description |
---|---|---|
nft_id* | string | The ID of the NFT. NFT is the smart contract that implements the Card on the blockchain. |
Query Parameters
Name | Type | Description |
---|---|---|
isAll | bool | If TRUE, it returns the informatino of all your Cards. Not usable with the |
cursor | string | The pointer from which to return the next 100 objects. Not usable with the |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Example
Response Details
Item | Type | Description |
---|---|---|
name | string | The name of the Card. |
symbol_img | string | The URL address of the image to be used for the Card. |
cards | array | An array of |
next_cursor | string | The pointer after which the next request will retrieve the next 100 items if the number of Cards exceeds 100. |
Response Details for cards[i]
Item | Type | Description |
---|---|---|
created_at | number | The time at which the Card was minted. |
updated_at | number | The time at which the Card was updated. |
owner | string | The EOA address of the Card owner. |
sender | string | The EOA address of the sender. |
card_id | number | The ID of the Card. |
card_uri | string | The URL of the JSON file containing Cards' metadata. |
transaction_hash | string | The hash of the smart contract transaction that minted the Card. |
For more details, please refer to our Card Minting Tutorial-1 and Card Minting Tutorial-2. If you need help with this document or with Klip in general, please visit our Developer Forum.
Delete Card
Delete Card
DELETE
https://api.klipwallet.com/v2/wallet/nft
Deletes a specified Card.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that will be used to sign the transaction. |
card_id* | number | The ID of the Card. |
contract_address* | string | The address of the SCA that minted the Cards. |
You cannot delete Cards that you sent to others. Deleting the Cards will not delete the Card image.
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Approve Escrow
Approve Escrow
POST
https://api.klipwallet.com/v2/escrow/approve
Enables the use of escrow for sending Cards. You have send a request to this API at least once to use escrow.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that will be used to sign the transaction. |
contract_address* | string | The address of the SCA that minted the Card. |
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Get Escrow Approval Status
Get Escrow Approval Status
GET
https://api.klipwallet.com/v2/escrow/approve
Shows whether escrow is enabled or not.
Query Parameters
Name | Type | Description |
---|---|---|
contract_address* | string | The address of the SCA that minted the Card. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Create Escrow
Create Escrow
POST
https://api.klipwallet.com/v2/escrow
Initiates escrow process by creating a link through which Klip user can receive the Card.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that will be used to sign the transaction. |
card_ids* | array | An array of |
contract_address* | string | The address of the SCA that minted the Card. |
You can only create escrows for Cards you hold, and not the ones sent. The Cards that are in escrow can be listed using Get Cards in Escrow.
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Get Cards in Escrow
Get Cards in Escrow
GET
https://api.klipwallet.com/v2/escrow
Returns a list of Cards in escrow.
Query Parameters
Name | Type | Description |
---|---|---|
contract_address* | string | The address of the SCA that minted the Card. |
cursor | string | The pointer from which to return the next 100 objects. If you make a GET request for over 100 Cards, it will return 100 items in the result and a |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
For more details on cursor
, please refer to Pagination.
Request Example
Response Details
Item | Type | Description |
---|---|---|
name | string | The name of the Card. |
symbol_img | string | The URL address of the image to be used for the Card. |
cards | array | An array of |
next_cursor | string | The pointer after which the next request will retrieve the next 100 items if the number of Cards exceeds 100. |
Response Details for cards[i]
Item | Type | Description |
---|---|---|
created_at | number | The time at which the Card was minted. |
updated_at | number | The time at which the Card was updated. |
owner | string | The EOA address of the Card owner. |
sender | string | The EOA address of the sender. |
card_id | number | The ID of the Card. |
card_uri | string | The URL of the JSON file containing the Card's metadata. |
transaction_hash | string | The hash of the smart contract transaction that minted the Card. |
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Cancel Escrow
Cancel Escrow
DELETE
https://api.klipwallet.com/v2/escrow
Cancels the escrow process for Cards that are in escrow.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
pin* | string | The PIN Code that will be used to sign the transaction. |
card_ids* | array | An array of |
contract_address* | string | The address of the SCA that minted the Card. |
This only works for Cards that are currently in escrow, and not Cards already sent. Cancelled Cards will return to the list.
Request Example
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Get Transaction Result
Get Transaction Result
GET
https://api.klipwallet.com/v2/wallet/receipt
Returns whether the transaction has been successfully recorded on blockchain.
Query Parameters
Name | Type | Description |
---|---|---|
tx_hash* | string | The hash of the transaction to make the query on. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | A JWT authentication token. |
Content-Type* | string | application/json |
Request Example
Response Details
Item | Type | Description |
---|---|---|
success | bool | Returns whether the transaction was successful. |
For more details, please refer to our Card Minting Tutorial. If you need help with this document or with Klip in general, please visit our Developer Forum.
Last updated