API

In order to use different API's endpoints you need to pass a special Header that contains API Token:

Authorization: Bearer <token>

You will get 401 Unauthorized error if you don't pass correct API Token in the Header.

API Token can be found on the API Integration page

Request example: API Token

curl-X GET https://cardlink.link/api/v1/payment/status?id=lGPmp4mYeE \
--header 'Authorization: Bearer 69|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Possible errors

Response example: authorization error

{
  "message": "Unauthenticated."
}

If you need to change your API token, you can do that on the API integration page by pressing the Refresh API token. As soon as you change your token, the old one will stop being active. Make sure to change it in all of your projects.

How to create a bill.

Request example

Response Parameters

Request example

curl -X POST 'https://cardlink.link/api/v1/bill/create'
-H 'Authorization: Bearer 69|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'amount=123.45' \
-d 'description=Some desc' \
-d 'order_id=123' \
-d 'type=multi' \
-d 'shop_id=EG8vrGXmLR' \
-d 'custom=Text'

Response

{
  "success": "true",
  "link_url": "https://cardlink.link/link/GkLWvKx3",
  "link_page_url": "https://cardlink.link/transfer/GkLWvKx3",
  "bill_id": "GkLWvKx3"
}

Possible errors

You can deactivate and activate bills using this APO.
Use your merchant token for the authentication.

Request parameters

Response params

Request example

curl -X POST 'https://cardlink.link/api/v1/bill/toggle_activity' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'id=LXZv3R7Q5B' \
-d 'active=1'

Ответ

{
 "id": "LXZv3R7Q5B",
 "activity": "false",
 "status": "NEW",
 "type": "MULTI",
 "amount": 100.05,
 "currency_in": "USD",
 "created_at": "2020-11-11 14:46:20",
 "success": true
}

Possible errors

Get information about payments for one bill.

Request parameters

Response example

Payment

Request example 

curl -X GET 'https://cardlink.link/api/v1/bill/payments?id=LXZv3R7Q8B' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response

{
 "data": [
  {
    "id": "PQX2XD25a0",
    "bill_id": "5QWlqB2kKJ",
    "status": "SUCCESS",
    "amount": 35400,
    "amount_received": 33875.6,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
  {
    "id": "zeAmwP2d5Q",
    "bill_id": "5QWlqB3kKJ",
    "status": "NEW",
    "amount": 3200,
    "amount_received": 3062.2,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-10-18 17:00:00"
  },
  {
    "id": "NDa7lNmdzx",
    "bill_id": "5QWlqB4kKJ",
    "status": "FAIL",
    "amount": 26100,
    "amount_received": 24976.08,
    "from_card": "553691******4442",
    "currency_in": "RUB",
    "created_at": "2020-10-01 17:00:00"
  }
 ],
 "success": true
}

Possible errors

Search by bills.

Request parameters

Response parameters

Bill

Request example

curl -X GET 'https://cardlink.link/api/v1/bill/search?start_date=2020-10-01&finish_date=2020-10-20' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response

{
 "data": [{
   "id": "LXZv3R7Q5B",
   "status": "NEW",
   "type": "MULTI",
   "amount": 100.05,
   "to_card": "424242******4242",
   "currency_in": "RUB",
   "created_at": "2020-11-11 14:46:20",
   "success": true
 }],
 "success": true
}

Possible errors

Get bill info and status.

Request parameters

Response parameters

Request example

curl-X GET 'https://cardlink.link/api/v1/bill/status?id=lGPmp4mYeE' \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response

{
  "id": "LXZv3R7Q5B",
  "status": "NEW",
  "type": "MULTI",
  "amount": 100.05,
  "currency_in": "RUB",
  "created_at": "2020-11-11 14:46:20",
  "success": true
}

Possible errors

Search payment.

Request parameters

Response example

Payment

Request example

curl -X GET 'https://cardlink.link/api/v1/payment/search?start_date=2020-10-01&finish_date=2020-10-20' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response

{
 "data": [
  {
    "id": "PQX2XD25a0",
    "bill_id": "do5G93m",
    "status": "SUCCESS",
    "amount": 35400,
    "amount_received": 33875.6,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
  {
    "id": "zeAmwP2d5Q",
    "bill_id": "do5G93m",
    "status": "NEW",
    "amount": 3200,
    "amount_received": 3062.2,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-10-18 17:00:00"
  },
  {
    "id": "NDa7lNmdzx",
    "bill_id": "do5G93m",
    "status": "FAIL",
    "amount": 26100,
    "amount_received": 24976.08,
    "from_card": "553691******4442",
    "currency_in": "RUB",
    "created_at": "2020-10-01 17:00:00"
  }
 ],
 "success": true
}

Possible errors

Get status of payment.

Request parameters 

Response example

Request example

curl-X GET 'https://cardlink.link/api/v1/payment/status?id=lGPmp4mYeE' \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response

{
 "id": "AbxvAM6vJk",
 "bill_id": "lx286Wo4vK",
 "status": "NEW",
 "amount": 0,

 "from_card": "555555******4444",
 "amount_received": 1000,
 "currency_in": "RUB",
 "created_at": "2021-01-02 01:02:03",
 "success": true
}

Possible errors

You can request information about your current balance state using this API.Use your merchant token for the authentication.

Request parameters

No

Response parameters

Balance

Example

curl -X GET 'https://cardlink.link/api/v1/merchant/balance' \
-H 'Authorization: Bearer 1|gdzr1215Z5EO3nGSVFBGdTG4APuG5tngYCqk69RbdPKYkTfK1LZg2rgakKWx3JI14kKEFLZGwijI'

Response

{
  "success": "true",
  "balances": [
   {
    "currency": "RUB",
    "balance_available": "93988.37000000",
    "balance_locked": "0.00000000",
    "balance_hold": "0.00000000"
   }
  ]
}

Possible errors

In order to withdraw money you need to create a payout. The amount of payout can be split depending on payout account type. In this case you will get a list with payouts.

Request paramters

Request paramets

Payout

Request example

curl -X POST 'https://cardlink.link/api/v1/payout/personal/create' \
-H 'Authorization: Bearer 10|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'amount=1500' \
-d 'payout_account_id=EG8Rz'

Response

{
 "data": [
  {
    "id": "gY37jYr2b6",
    "status": "MODERATING",
    "amount": 1500,
    "commission": 100,
    "account_identifier": "676454******7272",
    "currency": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
 ],
 "success": true
}

Possible errors

Attention: You need to request access to this API method from Support Team.

Payout to cards using your account balance.
You request can be split if amount is too large. In this case you will see a list of payouts.

Request parameters

Response parameters

Payout

Request example

curl -X POST 'https://cardlink.link/api/v1/payout/regular/create' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'amount=1500' \
-d 'account_type=credit_card'\
-d 'account_identifier=4242424242424242'

Response

{
 "data": [
  {
    "id": "gY37jYr2b6",
    "status": "MODERATING",
    "amount": 1600,
    "commission": 100,
    "account_identifier": "676454******7272",
    "currency": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
 ],
 "success": true
}

Possible errors

You can request all your payouts using this method.

Request parameters

Response parameters

Payout

Exampleа

curl -X GET 'https://cardlink.link/api/v1/payout/search?start_date=2020-10-01&finish_date=2020-10-20' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI'

Ответ

{
 "data": [
  {
    "id": "gY37jYr2b6",
    "status": "MODERATING",
    "amount": 1600,
    "commission": 100,
    "account_identifier": "676454******7272",
    "currency": "RUB",
    "created_at": "2020-10-19 17:00:00"
  },
 ],
 "success": true
}

Possible errors

You can request a status of any payout operation.

Request parameters

Response parameters

Payout

Request example

curl-X GET 'https://cardlink.link/api/v1/payout/status?id=lGPmp4mYeE' \
--header 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Ответ

{
 "id": "lGPmp4mYeE",
 "status": "MODERATING",
 "amount": 1600,
 "commission": 100,
 "account_identifier": "676454******7272",
 "currency": "RUB",
 "created_at": "2020-10-19 17:00:00"
 "success": true
}

Possible errors

You can request list of active SBP banks using this API. Use your merchant token for the authentication.

Request parameters

No

Response parameters

SBP Bank

Example

curl -X GET 'https://cardlink.link/api/v1/payout/dictionaries/sbp_banks' \
-H 'Authorization: Bearer 1|gdzr1215Z5EO3nGSVFBGdTG4APuG5tngYCqk69RbdPKYkTfK1LZg2rgakKWx3JI14kKEFLZGwijI'

Response

{
  "success": "true",
  "data": [
   {
    "member_id": 100000000202,
    "name": "Норвик Банк",
    "name_en": "Norvik Bank",
    "bic": 43304728
   },
   {
    "member_id": 100000000032,
    "name": "Ренессанс Кредит",
    "name_en": "Renaissance Credit",
    "bic": 44525135
   }
  ]
}

Possible errors

Important: API is available upon request via support.

Used to make a full refund.

Request parameters

Response parameters

Request example

curl -X POST 'https://cardlink.link/api/v1/refund/full/create' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'payment_id=LXZv3R7Q8B'


Response

{
 "id": "5QWlqB2kKJ",
 "status": "NEW",
 "amount": 1355.91,
 "currency": "RUB",
 "entity_type": "payment",
 "entity_id": "LXZv3R7Q8B",
 "created_at": "2020-10-19 17:00:00",
 "success": true
}

Possible errors

Important: API is available upon request via support.

Used to make a partial refund.

Request parameters

Response parameters

Request example

curl -X POST 'https://cardlink.link/api/v1/refund/partial/create' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI' \
-d 'payment_id=LXZv3R7Q8B'


Response

{
 "id": "5QWlqB2kKJ",
 "status": "NEW",
 "amount": 1355.91,
 "currency": "RUB",
 "entity_type": "payment",
 "entity_id": "LXZv3R7Q8B",
 "created_at": "2020-10-19 17:00:00",
 "success": true
}

Possible errors

Get refund status.

Request parameters

Response parameters

Request example

curl -X GET 'https://cardlink.link/api/v1/refund/status?id=5QWlqB2kKJ' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI'


Response

{
 "id": "5QWlqB2kKJ",
 "status": "NEW",
 "amount": 24600.05,
 "currency": "RUB",
 "entity_type": "payment",
 "entity_id": "LXZv3R7Q8B",
 "created_at": "2020-10-19 17:00:00",
 "success": true
}

Possible errors

With this method you can get all refund for a period.

Query parameters

Response parameters

Refund

Request example

curl -X GET 'https://cardlink.link/api/v1/refund/search?start_date=2020-10-01&finish_date=2020-10-20' \
-H 'Authorization: Bearer 5|gdzr815Z5EO2nGSVFBGdTG6APuj7tngYCqk59RbdPKYkTfK4LZg3rgakKWx8JIO7kKEFLZGwijI'

Response

{
 "data": [
  {
    "id": "5QWlqB2kKJ",
    "status": "NEW",
    "amount": 24600.05,
    "currency": "RUB",
    "entity_type": "payment",
    "entity_id": "LXZv3R7Q8B",
    "created_at": "2020-10-19 17:00:00",
    "success": true
  },
 ],
 "success": true
}

Possible errors

If you added a shop and set a result url in shop settings, you will get a POST request with information about payments.

Request example

{
 "InvId": 123,
 "OutSum": 12345,
 "CurrencyIn": "RUB",
 "Commission": 123,
 "TrsId": "AbxvAM6vJk",
 "Status": "SUCCESS",
 "custom": "custom_information",
 "SignatureValue": "KWE3FDF98UEWMS7733SWQWPCPL1LA10Y"
}

If you set a payout webhook url in Webhooks, you will get a POST request with information about payouts.

Example

{
 "TrsId": "ZqmawDQ9B7l",
 "Amount": "50010.00000000",
 "IsAuto": false,
 "Status": "SUCCESS",
 "Currency": "RUB",
 "Commission": "10.00000000",
 "AccountType": "QIWI",
 "AccountNumber": "+79999999999",
 "BalanceAmount": "50010.00000000",
 "SignatureValue": "5FC958AE222AF2E49881DEB815B8E8A2",
 "BalanceCurrency": "RUB",
 "BalanceCommission": "10.00000000",
 "CommissionApplyType": "sender"
}

After a failed payment, user will be redireceted to Fail URL that you set in Shop's settings. The redirect works like a POST request to Fail URL.

Request parameters

Example

{
 "InvId": 123,
 "OutSum": 12345,
 "custom": "custom_information",
 "CurrencyIn": "RUB",
 "SignatureValue": "KWE3FDF98UEWMS7733SWQWPCPL1LA10Y"
}

After a success payment, user will be redireceted to Success URL that you set in Shop's settings. The redirect works like a POST request to Success URL.

Request parameters

Example

{
 "InvId": 123,
 "OutSum": 12345,
 "custom": "custom_information",
 "CurrencyIn": "RUB",
 "SignatureValue": "KWE3FDF98UEWMS7733SWQWPCPL1LA10Y"
}