API integration

In order to access the necessary methods, you need to in the Authorization header, pass the token:

Authorization: Bearer {token}
Otherwise, the server will return an authorization error 401.
You can get the token on the API integrations page in your personal account

Request example


            curl -X  'https://cardlink.link/api/v1/bill/create' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token

For a basic connection to the service, you need to learn how to work with one type of request and handle postback.
The main request you need to get started is /api/v1/bill/create

Example request:

curl --location --request POST 'https://cardlink.link/api/v1/bill/create' \
--header 'Authorization: Bearer 123|q4uNcWNKMNZoSFSY1XTxp36nsM0kUMSu0otSA95' \
--form 'amount=16' \
--form 'order_id="Order 123"' \
--form 'description="Payment Description"' \
--form 'type="normal"' \
--form 'shop_id="G1vrEyX0LR"' \
--form 'currency_in="RUB"' \
--form 'custom="my_custom_data"' \
--form 'payer_pays_commission=1' \
--form 'name="Payment"'

Example response:

{
  "success": "true",
  "link_url": "https://cardlink.shop/en/link/3P1p2rgW7Y",
  "link_page_url": "https://cardlink.shop/en/transfer/3P1p2rgW7Y",
  "bill_id": "3P1p2rgW7Y
}

Next, you need to redirect the user to the link specified in "link_page_url". After payment, the user will be redirected to the page specified in Success/Fail URL depending on the payment status.

The user is redirected via a POST request of the following format:

{
  "OutSum": "18.54",
  "CurrencyIn": "RUB",
  "InvId": "Order 123",
  "custom": "my_custom_data",
  "SignatureValue": "5A41374P24C99A2156D1D306C800B53C"
}

After redirecting to Success or Fail URL, the user should see a message with the payment status.
Since you can get the order_id back, and in the example above - this is the InvId field, you can immediately show a message like

Your order InvId has been successfully paid. Thank you for your payment!
or

Payment for order InvId failed. Please try again or contact support
You will also receive a Postback to the Result URL specified in the store settings. The data format is as follows:

{
  "Status": "SUCCESS",
  "InvId": "Order 123",
  "Commission": "2.54",
  "CurrencyIn": "RUB",
  "OutSum": "18.54",
  "TrsId": "3P1p2rgW7Y",
  "custom": "my_custom_data",
  "SignatureValue": "4A41373E24C99A2656D1D306C800B53C
}

Based on this Postback, you need to change the order status in your system.
Having received the SUCCESS status, you change the order status in your database to "PAID"
Having received the FAIL status, you accordingly change the order status in your system to "NOT PAID"
The above is enough to start accepting payments.

As a result of a successful payment, the user is redirected to the Success URL specified in the shop settings. The redirect is sent as a POST request to the Success URL.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
InvId	Yes	string		payment-19238465	order_id field passed when creating the bill
OutSum	Yes	decimal		380.55	Payment amount
CurrencyIn	Yes	enum	USD RUB EUR	RUB	The currency in which the bill was paid
custom	No	string		additional_information	Custom field, passed when creating a bill
SignatureValue	Yes	string		DC32D403CE6BD2E54D4D213278DB286C	Request signature. It is formed as follows: `strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken))`

Request example


            curl -X POST 'https://cardlink.link/redirect/payment/success' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'InvId=123'  \
                                    -d 'OutSum=12345'  \
                                    -d 'CurrencyIn=RUB'  \
                                    -d 'custom=custom_information'  \
                                    -d 'SignatureValue=398320589F8E31ACE27CC681BCBD8BDA'

As a result of an unsuccessful payment, the user is redirected to the Fail URL specified in the shop settings. The redirection is in the form of a POST request to the Fail URL.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
InvId	Yes	string		payment-19238465	order_id field passed when creating the bill
OutSum	Yes	decimal		380.55	Payment amount
CurrencyIn	Yes	enum	USD RUB EUR	RUB	The currency in which the bill was paid
custom	No	string		additional_information	Custom field, passed when creating a bill
SignatureValue	Yes	string		DC32D403CE6BD2E54D4D213278DB286C	Request signature. It is formed as follows: `strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken))`

Request example


            curl -X POST 'https://cardlink.link/redirect/payment/fail' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'InvId=123'  \
                                    -d 'OutSum=12345'  \
                                    -d 'CurrencyIn=RUB'  \
                                    -d 'custom=custom_information'  \
                                    -d 'SignatureValue=398320589F8E31ACE27CC681BCBD8BDA'

Parameter name	Type	Format	Possible values	Example	Description
id	string			jZqmaPvl9W	Unique bill identifier
order_id	string			order-285394168	Unique order identifier on your side
active	boolean		true false	true	Bill activity flag
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Bill status
amount	decimal			24600.05	Bill amount
type	enum		MULTI NORMAL	MULTI	Bill type
created_at	datetime	Y-m-d H:i:s		2020-10-19 17:00:00	Date and time of bill creation
currency_in	enum		USD RUB EUR	USD	The currency in which the bill is paid
ttl	enum			600	Bill lifetime in seconds.

In order to make a payment, you need to create a bill. If the bill type is MULTI, then several payments can be made on one bill. The domain in shop_url must match the domain of success_url and fail_url.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
amount	Yes	decimal		380.99	Bill amount
shop_id	Yes	string		LXZv3R7Q8B	Unique identifier of the shop the payment belongs to. Without this parameter, Success URL, Fail URL and Result URL will not work
order_id	No	string		order-285394168	Unique identifier of the order. Will be returned in postback.
description	No	string		Order #285394168	Payment description
type	No	enum	normal multi	normal	Bill type. NORMAL (one-time) or MULTI (reusable). If NORMAL is selected, you will not be able to pay a second time.
currency_in	No	enum	RUB USD EUR	RUB	The currency in which the bill is paid. If not passed, the shop currency is used. If shop_id is not defined, RUB is used.
custom	No	string		my-custom-string	Custom field. Will be returned in postback.
payer_pays_commission	No	enum	1 0	1	Parameter that specifies who will pay the commission for the incoming payment.
payer_email	No	string		[email protected]	Parameter that fills in the client's email on the payment page.
name	No	string		Donation	Link name. Specify what you are accepting funds for. This text will be displayed in the payment form.
ttl	No	integer		600	Bill lifetime in seconds.
success_url	No	string		https://exmpl.com/order-285394168/success	Successful payment page.
fail_url	No	string		https://exmpl.com/order-285394168/fail	Failed payment page.
payment_method	No	enum	BANK_CARD SBP	SBP	If this parameter is specified, then when switching to the payment form, this payment method will be selected automatically, without the possibility of choosing another payment method.
request_fields[email]	No	boolean		false	If this parameter is specified, payer must fill in the email
request_fields[phone]	No	boolean		false	If this parameter is specified, payer must fill in the phone number
request_fields[name]	No	boolean		false	If this parameter is specified, payer must fill in the name
request_fields[comment]	No	boolean		false	If this parameter is specified, payer must fill in the comment
items	No	array		items[0][name]="Digital Item" items[0][price]="390" items[0][quantity]="1" items[0][category]="digital" items[0][extra][phone]="+79999999999"	Array of bill items

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
success	boolean		true false	true	Request success flag
link_url	string	URL		https://cardlink.shop/en/link/5QWlqB2kKJ	Link to page with QR code
link_page_url	string	URL		https://cardlink.shop/en/transfer/5QWlqB2kKJ	Payment link
bill_id	string			5QWlqB2kKJ	Unique bill identifier

Request example


            curl -X POST 'https://cardlink.link/api/v1/bill/create' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'amount=100.05'  \
                                    -d 'description=Some desc'  \
                                    -d 'order_id=15'  \
                                    -d 'type=multi'  \
                                    -d 'shop_id=LXZv3R7Q8B'  \
                                    -d 'custom=123'  \
                                    -d 'currency_in=RUB'

Response example


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

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.invalid_amount	Invalid amount
403	api:error.merchant_banned	Merchant is banned
403	api:error.merchant_not_found	Merchant not found
403	api:error.shop_not_found	Shop not found
403	api:error.shop_not_enabled	Shop is not enabled
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.rate-not-found	Rate not available
422		Input data validation error
500	api:error.general_error	Internal error

Deactivating a bill can be useful for manually disabling a payment link with the MULTI type, since this type of payment links does not change its status after payment and can be paid as many times as you like.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
id	Yes	string		LXZv3R7Q8B	Unique bill identifier
active	Yes	boolean	0 1	0	0 - deactivate bill, 1 - activate bill

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			jZqmaPvl9W	Unique bill identifier
order_id	string			order-285394168	Unique order identifier on your side
active	boolean		true false	true	Bill activity flag
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Bill status
amount	decimal			24600.05	Bill amount
type	enum		MULTI NORMAL	MULTI	Bill type
created_at	datetime	Y-m-d H:i:s		2020-10-19 17:00:00	Date and time of bill creation
currency_in	enum		USD RUB EUR	USD	The currency in which the bill is paid
ttl	enum			600	Bill lifetime in seconds.
success	boolean		true false	true	Request success flag

Request example


            curl -X POST 'https://cardlink.link/api/v1/bill/toggle_activity' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'id=LXZv3R7Q5B'  \
                                    -d 'active=1'

Response example


            {
    "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

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.merchant_banned	Merchant is banned
403	api:error.merchant_not_found	Merchant not found
403	api:error.bill_not_found	Bill not found
403	api:error.merchant_subscription_inactive	Subscription is inactive
403	api:error.merchant_subscription_not_found	Merchant does not have a subscription
403	api:error.bill_is_finished	Bill already paid (for "NORMAL" bill type)
422		Input data validation error
500	api:error.general_error	Internal error

Use this method to get all payments for the bill.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
id	Yes	string		LXZv3R7Q8B	Unique bill identifier

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
data	array	Payment		See description Payment	Array of payments related to this bill
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/bill/payments?id=LXZv3R7Q8B' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


            {
    "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

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.too_many_payments	The request is trying to get too many payments
403	api:error.merchant_banned	Merchant is banned
403	api:error.merchant_not_found	Merchant not found
403	api:error.bill_not_found	Bill not found

Search by bills. You can specify time periods or a shop to find the bills you need.

Request parameters

Parameter name	Required parameter	Type	Example	Description
start_date	No	datetime	2025-01-01	Start datetime for receiving bills in UTC
finish_date	No	datetime	2024-12-01 23:59:59	End datetime for receiving bills in UTC
shop_id	No	string	LXZv3R7Q8B	Unique shop identifier
per_page	No	integer	50	Number of items per page
cursor	No	string	eyJpZCI6NzY1LCJfcG	Pointer to page

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
success	boolean		true false	true	Request success flag
data	array	Bill		See description Bill	Array of bills
links	array	Links		See Pagination Links	Pagination Links
meta	array	Meta		See description Pagination Meta	Pagination Meta Data

Request example


            curl -X GET 'https://cardlink.link/api/v1/bill/search?start_date=2024-01-01&finish_date=2025-12-01' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


            {
    "success": true,
    "data": [
        {
            "id": "LXZv3R7Q5B",
            "status": "NEW",
            "type": "MULTI",
            "amount": 100.05,
            "currency_in": "RUB",
            "created_at": "2020-11-11 14:46:20"
        }
    ],
    "links": {
        "prev": "https://cardlink.shop/api/v1/bill/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.shop/api/v1/bill/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.shop/api/v1/bill/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.bill_not_found	Bill not found
403	api:error.shop_not_found	Shop not found. Occurs only if shop_id was passed
422		Input data validation error

If the bill has type MULTI, its status will not be changed.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
id	Yes	string		LXZv3R7Q8B	Unique bill identifier

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			jZqmaPvl9W	Unique bill identifier
order_id	string			order-285394168	Unique order identifier on your side
active	boolean		true false	true	Bill activity flag
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Bill status
amount	decimal			24600.05	Bill amount
type	enum		MULTI NORMAL	MULTI	Bill type
created_at	datetime	Y-m-d H:i:s		2020-10-19 17:00:00	Date and time of bill creation
currency_in	enum		USD RUB EUR	USD	The currency in which the bill is paid
ttl	enum			600	Bill lifetime in seconds.
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/bill/status?id=LXZv3R7Q5B' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


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

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.bill_not_found	Bill not found
403	api:error.shop_not_found	Shop not found. Occurs only if shop_id was passed
422		Input data validation error

Parameter name	Type	Format	Possible values	Example	Description
id	string			jZqmaPvl9W	Unique payment identifier
bill_id	string			do5G93m	Unique identifier of the bill to which the payment belongs
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Payment status
amount	decimal			4039.65	Payment amount
commission	decimal			39.65	Commission
account_amount	decimal			4000.00	Amount credited to balance
account_currency_code	string			RUB	Currency credited to balance
from_card	string			671254******7272	Payer's card
currency_in	enum		USD RUB EUR	RUB	The currency in which the bill is paid
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time of payment creation
error_code	integer			400	Error code
error_message	string			Limits exceeded	Error description

With this method you can get all payments for a shop or for a custom period of time.

Request parameters

Parameter name	Required parameter	Type	Example	Description
start_date	No	datetime	2025-01-01	Start datetime for payments in UTC
finish_date	No	datetime	2024-12-01 23:59:59	End datetime for payments in UTC
shop_id	No	string	LXZv3R7Q8B	Unique shop identifier
per_page	No	integer	50	Number of items per page
cursor	No	string	eyJpZCI6NzY1LC	Pointer to page

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
success	boolean		true false	true	Request success flag
data	array	Payment		See description Payment	Payment information
links	array	Links		See Pagination Links	Pagination Links
meta	array	Meta		See description Pagination Meta	Pagination Meta Data

Request example


            curl -X GET 'https://cardlink.link/api/v1/payment/search?start_date=2024-01-01&finish_date=2025-12-01' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


            {
    "success": true,
    "data": [
        {
            "id": "PQX2XD25a0",
            "bill_id": "do5G93m",
            "status": "SUCCESS",
            "amount": 35400,
            "from_card": "676454******7272",
            "currency_in": "RUB",
            "created_at": "2020-10-19 17:00:00"
        },
        {
            "id": "zeAmwP2d5Q",
            "bill_id": "do5G93m",
            "status": "NEW",
            "amount": 3200,
            "from_card": "676454******7272",
            "currency_in": "RUB",
            "created_at": "2020-10-18 17:00:00"
        },
        {
            "id": "NDa7lNmdzx",
            "bill_id": "do5G93m",
            "status": "FAIL",
            "amount": 26100,
            "from_card": "553691******4442",
            "currency_in": "RUB",
            "created_at": "2020-10-01 17:00:00",
            "error_code": 168,
            "error_message": "3ds not passed"
        }
    ],
    "links": {
        "prev": "https://cardlink.shop/api/v1/payment/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.shop/api/v1/payment/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.shop/api/v1/payment/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.bill_not_found	Bill not found
403	api:error.shop_not_found	Shop not found. Occurs only if shop_id was passed
422		Input data validation error

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
id	Yes	string		LXZv3R7Q8B	Unique payment identifier

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			jZqmaPvl9W	Unique payment identifier
bill_id	string			do5G93m	Unique identifier of the bill to which the payment belongs
status	enum		NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL	NEW	Payment status
amount	decimal			4039.65	Payment amount
commission	decimal			39.65	Commission
account_amount	decimal			4000.00	Amount credited to balance
account_currency_code	string			RUB	Currency credited to balance
from_card	string			671254******7272	Payer's card
currency_in	enum		USD RUB EUR	RUB	The currency in which the bill is paid
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time of payment creation
error_code	integer			400	Error code
error_message	string			Limits exceeded	Error description
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/payment/status?id=lGPmp4mYeE' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


            {
    "id": "LXZv3R7Q8B",
    "bill_id": "do5G93m",
    "status": "NEW",
    "amount": 0,
    "from_card": "676454******7272",
    "currency_in": "RUB",
    "created_at": "2020-11-03 06:43:36",
    "success": true
}

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.payment_not_found	Payment not found
422		Input data validation error

Parameter name	Type	Possible values	Example	Description
currency	enum	USD RUB EUR	RUB	Balance currency
balance_available	decimal		93988.37000000	Available balance
balance_locked	decimal		0.00000000	Blocked balance during payout
balance_hold	decimal		0.00000000	Temporarily held balance. Becomes available after some time

Request parameters

No

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
balances	array	Balance		See description Balance	An array containing information about merchant balances
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/merchant/balance' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


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

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.merchant_banned	Merchant is banned
422		Input data validation error

Parameter name	Type	Format	Possible values	Example	Description
id	string			LXZv3R7Q8B	Unique payout identifier
status	enum		NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED	NEW	Payout status
order_id	string			payout-19238465	Unique order identifier
account_identifier	string			+79123456789	Payment account to which the payout is made
amount	decimal			4000	In case of recipient_pays_commission:false the amount field is the payment amount taking into account the commission, in case of recipient_pays_commission:true the amount field is the original payment amount
account_amount	decimal			4039.65	Amount debited from the balance
commission	decimal			39.65	Service commission
account_commission	decimal			39.65	Service commission in balance currency
currency	enum		USD RUB EUR	RUB	Payout currency
account_currency	enum		USD RUB EUR	RUB	Balance currency
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time of payout creation
error_code	integer			400	Error code
error_message	string			Limits exceeded	Error Description

Parameter name	Type	Example	Description
member_id	integer	100000000032	Member ID of the bank in the SBP system
name	string	Ренессанс Кредит	api-doc.sbp-bank:name-field-description
name_en	string	Renaissance Credit	Bank name in English
bic	integer	44525135	Bank BIC

Important: The API is provided upon request through the support service.

In order to withdraw funds from the system balance, you need to create a payout. The payout request can be split into several payouts depending on the account used. In this case, you will receive a list of multiple payouts in the response.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
amount	Yes	decimal		380.99	Payout amount
payout_account_id	Yes	string		LXZv3R7Q8B	Unique identifier of the payment account to which the payout will be made.
account_currency	No	enum	USD RUB EUR	RUB	The currency of the balance from which the funds for the payout should be debited.
recipient_pays_commission	No	boolean	true false	false	The parameter responsible for who pays the commission (true - the commission is paid by the recipient of the payout, if false - the commission will be deducted from the account balance)
order_id	No	string		payout-384685192	Unique order identifier.

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
data	array	Payout		See description Payout Resource	Payout information
success	boolean		true false	true	Request success flag

Request example


            curl -X POST 'https://cardlink.link/api/v1/payout/personal/create' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'amount=1500'  \
                                    -d 'payout_account_id=EG8Rz3R7Q8B'

Response example


            {
    "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

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
400	api:error.invalid_amount	Invalid amount
400	api:error.merchant_banned	Merchant is banned
400	api:error.merchant_not_found	Merchant not found
400	api:error.payout_account_not_found	Payout account not found
400	api:error.payout_account_banned	Payout account is banned
400	api:error.daily_payout_limit_exceeded	Daily account limit exceeded
400	api:error.monthly_payout_limit_exceeded	Monthly account limit exceeded
400	api:error.balance_not_enough	Insufficient balance for payout
400	api:error.direction_not_available	Payout for this account is not available
400	api:error.merchant_not_verified	Merchant is not verified
403	This action is unauthorized	Merchant is not verified
422		Input data validation error
500	api:error.general_error	Internal error

Important: The API is available upon request through the support service.

In order to withdraw funds from the system balance, you need to create a payment. The payout request can be split into several payments depending on the account used. In this case, you will receive a list of multiple payouts in response.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
amount	Yes	decimal		380.99	Payout amount
currency	Yes	enum	USD RUB EUR	RUB	Currency
account_type	Yes	enum	credit_card sbp crypto steam	credit_card	The type of account to which the funds are sent
account_identifier	Yes	string		+79123456789	Account identifier depending on account_type: credit_card - card number sbp - phone number crypto - wallet address steam - user\`s Steam login
account_bank	Yes	integer		100000000032	Bank member ID for account_type=sbp. You can get a list of available banks in this section
card_holder	Yes	string		IVAN IVANOV	Cardholder for account_type=credit_card. As indicated on the card.
account_network	Yes	string	TRX ETH	TRX	Network for sending cryptocurrency/tokens for account_type=crypto. TRX - Tron network, ETH - Ethereum.
account_currency	No	enum	USD RUB EUR	RUB	Balance currency
recipient_pays_commission	No	boolean	true false	false	Parameter responsible for who pays the commission (true - the commission is paid by the recipient of the payout, if false - the commission will be deducted from the account balance)
order_id	No	string		payout-384685192	Unique order identifier.

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
data	array	Payout		See description Payout Resource	Payout Information
success	boolean		true false	true	Request success flag

Request example


            curl -X POST 'https://cardlink.link/api/v1/payout/regular/create' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'amount=1500'  \
                                    -d 'currency=RUB'  \
                                    -d 'account_type=credit_card'  \
                                    -d 'account_identifier=4242424242424242'  \
                                    -d 'card_holder=IVAN IVANOV'  \
                                    -d 'account_currency=RUB'  \
                                    -d 'recipient_pays_commission=0'

Response example


            {
    "data": {
        "id": "gY37jYr2b6",
        "status": "MODERATING",
        "amount": 1600,
        "commission": 100,
        "account_identifier": "676454******7272",
        "currency": "RUB",
        "account_amount": null,
        "account_commission": null,
        "account_currency": "RUB",
        "created_at": "2024-10-19 17:00:00"
    },
    "success": true
}

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
400	api:error.invalid_amount	Invalid amount
400	api:error.merchant_banned	Merchant is banned
400	api:error.merchant_not_found	Merchant not found
400	api:error.payout_account_banned	Payout account is banned
400	api:error.daily_payout_limit_exceeded	Daily account limit exceeded
400	api:error.monthly_payout_limit_exceeded	Monthly account limit exceeded
400	api:error.balance_not_enough	Insufficient balance for payout
400	api:error.direction_not_available	Payout for this account is not available
400	api:error.merchant_not_verified	Merchant is not verified
403	This action is unauthorized	Merchant is not verified
422		Input data validation error
500	api:error.general_error	Internal error

Request parameters

Parameter name	Required parameter	Type	Example	Description
start_date	No	datetime	2025-01-01	Start datetime for receiving payouts in UTC
finish_date	No	datetime	2024-12-01 23:59:59	End datetime for receiving payouts in UTC
per_page	No	integer	50	Number of items per page
cursor	No	string	eyJpZCI6NzY1LCJfcG9	Pointer to page

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
success	boolean		true false	true	Request success flag
data	array	Payout		See description Payout Resource	Payout Array
links	array	Links		See Pagination Links	Pagination Links
meta	array	Meta		See description Pagination Meta	Pagination Meta Data

Request example


            curl -X GET 'https://cardlink.link/api/v1/payout/search?start_date=2024-01-01&finish_date=2025-12-01' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


            {
    "success": true,
    "data": [
        {
            "id": "gY37jYr2b6",
            "status": "MODERATING",
            "amount": 1600,
            "commission": 100,
            "account_identifier": "676454******7272",
            "account_amount": 1600,
            "account_commission": 100,
            "currency": "RUB",
            "created_at": "2024-10-19 17:00:00"
        }
    ],
    "links": {
        "prev": "https://cardlink.shop/api/v1/payout/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.shop/api/v1/payout/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.shop/api/v1/payout/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.merchant_not_found	Merchant not found
422		Input data validation error

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
id	Yes	string		LXZv3R7Q8B	Unique payout identifier. Required if order_id is not passed
order_id	Yes	string		payout-19238465	Unique order identifier. Required if id is not passed

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			LXZv3R7Q8B	Unique payout identifier
status	enum		NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED	NEW	Payout status
order_id	string			payout-19238465	Unique order identifier
account_identifier	string			+79123456789	Payment account to which the payout is made
amount	decimal			4000	In case of recipient_pays_commission:false the amount field is the payment amount taking into account the commission, in case of recipient_pays_commission:true the amount field is the original payment amount
account_amount	decimal			4039.65	Amount debited from the balance
commission	decimal			39.65	Service commission
account_commission	decimal			39.65	Service commission in balance currency
currency	enum		USD RUB EUR	RUB	Payout currency
account_currency	enum		USD RUB EUR	RUB	Balance currency
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time of payout creation
error_code	integer			400	Error code
error_message	string			Limits exceeded	Error Description
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/payout/status?id=lGPmp4mYeE' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


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

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.payout_not_found	Payout not found
422		Input data validation error

Request parameters

No

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
data	array	SBP Bank		See. description SBP Bank Resource	Array of banks
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/payout/dictionaries/sbp_banks' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


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

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
422		Input data validation error

Parameter name	Type	Format	Possible values	Example	Description
id	string			5QWlqB2kKJ	Unique Refund ID
status	string		NEW PROCESS SUCCESS FAIL	NEW	Refund Status
amount	decimal			1355.91	Refund Amount
currency	enum		USD RUB EUR	RUB	Currency
entity_type	string		payment	payment	Refund Type
entity_id	string			LXZv3R7Q8B	Unique identifier of the payment being refunded
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time the refund was created

Important: The API is available upon request through our support team.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
payment_id	Yes	string		LXZv3R7Q8B	Unique Payment ID

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			5QWlqB2kKJ	Unique Refund ID
status	string		NEW PROCESS SUCCESS FAIL	NEW	Refund Status
amount	decimal			1355.91	Refund Amount
currency	enum		USD RUB EUR	RUB	Currency
entity_type	string		payment	payment	Refund Type
entity_id	string			LXZv3R7Q8B	Unique identifier of the payment being refunded
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time the refund was created
success	boolean		true false	true	Request success flag

Request example


            curl -X POST 'https://cardlink.link/api/v1/refund/full/create' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'payment_id=LXZv3R7Q8B'

Response example


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

Possible errors

Response code	Error key	Error description
400	api:error.balance_not_enough	Insufficient balance for payout
401	Unauthenticated	Invalid API Token
400	api:error.merchant_banned	Merchant is banned
400	api:error.merchant_not_found	Merchant not found
403	This action is unauthorized	Merchant is not verified
500	api:error.general_error	Internal error

Important: The API is available upon request through our support team.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
payment_id	Yes	string		LXZv3R7Q8B	Unique Payment ID
amount	Yes	decimal		1355.91	Partial Refund Amount

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			5QWlqB2kKJ	Unique Refund ID
status	string		NEW PROCESS SUCCESS FAIL	NEW	Refund Status
amount	decimal			1355.91	Refund Amount
currency	enum		USD RUB EUR	RUB	Currency
entity_type	string		payment	payment	Refund Type
entity_id	string			LXZv3R7Q8B	Unique identifier of the payment being refunded
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time the refund was created
success	boolean		true false	true	Request success flag

Request example


            curl -X POST 'https://cardlink.link/api/v1/refund/partial/create' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'payment_id=LXZv3R7Q8B'

Response example


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

Possible errors

Response code	Error key	Error description
400	api:error.balance_not_enough	Insufficient balance for payout
401	Unauthenticated	Invalid API Token
400	api:error.merchant_banned	Merchant is banned
400	api:error.merchant_not_found	Merchant not found
403	This action is unauthorized	Merchant is not verified
500	api:error.general_error	Internal error

Request parameters

Parameter name	Required parameter	Type	Example	Description
payment_id	No	string	X5Pvg52096	Payment ID
start_date	No	datetime	2025-01-01	Start datetime for receiving refunds in UTC
finish_date	No	datetime	2024-12-01 23:59:59	End datetime for receiving refunds in UTC
per_page	No	integer	50	Number of items per page
cursor	No	string	eyJpZCI6NzY1LCJfcG9	Pointer to page

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
success	boolean		true false	true	Request success flag
data	array	refund		See description Refund Resource	Refund Information
links	array	Links		See Pagination Links	Pagination Links
meta	array	Meta		See description Pagination Meta	Pagination Meta Data

Request example


            curl -X GET 'https://cardlink.link/api/v1/refund/search?payment_id=LXZv3R7Q8B&start_date=2024-01-01&finish_date=2025-12-01' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


            {
    "success": true,
    "data": [
        {
            "id": "5QWlqB2kKJ",
            "status": "NEW",
            "amount": 1355.91,
            "currency": "RUB",
            "entity_type": "payment",
            "entity_id": "LXZv3R7Q8B",
            "created_at": "2024-10-19 17:00:00"
        }
    ],
    "links": {
        "prev": "https://cardlink.shop/api/v1/refund/search?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.shop/api/v1/refund/search?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.shop/api/v1/refund/search",
        "per_page": 1000,
        "next_cursor": "eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
        "prev_cursor": "eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ"
    }
}

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
400	api:error.merchant_banned	Merchant is banned
400	api:error.merchant_not_found	Merchant not found
422		Input data validation error
500	api:error.general_error	Internal error

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
id	Yes	string		LXZv3R7Q8B	Unique Refund ID

Response parameters

Parameter name	Type	Format	Possible values	Example	Description
id	string			5QWlqB2kKJ	Unique Refund ID
status	string		NEW PROCESS SUCCESS FAIL	NEW	Refund Status
amount	decimal			1355.91	Refund Amount
currency	enum		USD RUB EUR	RUB	Currency
entity_type	string		payment	payment	Refund Type
entity_id	string			LXZv3R7Q8B	Unique identifier of the payment being refunded
created_at	datetime	Y-m-d H:i:s		2024-12-19 17:32:55	Date and time the refund was created
success	boolean		true false	true	Request success flag

Request example


            curl -X GET 'https://cardlink.link/api/v1/refund/status?payment_id=LXZv3R7Q8B' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example


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

Possible errors

Response code	Error key	Error description
401	Unauthenticated	Invalid API Token
403	api:error.access_denied	Merchant does not have access to the shop
403	api:error.merchant_not_found	Merchant not found
403	api:error.refund_not_found	api-doc.error:refund_not_found
422		Input data validation error

As a result of the payment execution, Result URL specified in the shop settings, a POST request is sent with payment information. The request is sent in the format 'application/x-www-form-urlencoded'. If for some reason your server does not respond with a 200 code, notification will be sent again times. The postback resending strategy is exponential: 1 time per 10 ^ attempt number seconds (10 sec, 100 sec, 1000 sec...). Total of 5 resend attempts.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
InvId	Yes	string		payment-19238465	order_id field passed when creating the bill
OutSum	Yes	decimal		380.55	Payment amount
Commission	Yes	decimal		30.55	Payment commission
TrsId	Yes	string		LXZv3R7Q8B	Unique payment identifier
Status	Yes	enum	SUCCESS UNDERPAID OVERPAID FAIL	SUCCESS	Payment status
CurrencyIn	Yes	enum	USD RUB EUR	RUB	The currency in which the bill was paid
custom	No	string		additional_information	Custom field, passed when creating a bill
AccountType	No	enum	BANK_CARD SBP	BANK_CARD	Payment method
AccountNumber	No	string		220220******7046	Additional information about the payment method
BalanceAmount	No	decimal		350.00	The amount that has been credited to the balance
BalanceCurrency	No	enum	USD RUB EUR	RUB	The currency in which was credited funds to the balance
ErrorCode	No	integer		666	Error code
ErrorMessage	No	string		General error	Description errors
SignatureValue	Yes	string		DC32D403CE6BD2E54D4D213278DB286C	Request signature. It is formed as follows: `strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken))`

Request example


            curl -X POST 'https://cardlink.link/callback/payment/success' \

                                                            -d 'InvId=123'  \
                                    -d 'OutSum=12345'  \
                                    -d 'CurrencyIn=RUB'  \
                                    -d 'Commission=123'  \
                                    -d 'TrsId=AbxvAM6vJk'  \
                                    -d 'Status=SUCCESS'  \
                                    -d 'custom=custom_information'  \
                                    -d 'AccountType=BANK_CARD'  \
                                    -d 'AccountNumber=220220******7046'  \
                                    -d 'BalanceAmount=123'  \
                                    -d 'BalanceCurrency=RUB'  \
                                    -d 'SignatureValue=398320589F8E31ACE27CC681BCBD8BDA'

As a result of paoyut execution, if the Payout Webhook URL is specified in the profile settings, a POST request with payout information is sent.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
TrsId	Yes	string		LXZv3R7Q8B	Unique payout identifier
Amount	Yes	decimal		3150.00	Payout amount with commission
IsAuto	Yes	boolean	true false	false	Automatic payout flag
Status	Yes	enum	SUCCESS DECLINED FAIL	SUCCESS	Payout status
Currency	Yes	enum	USD RUB EUR USDT	RUB	Currency in which the payout is made
Commission	Yes	decimal		150.00	System commission in the payout currency
AccountType	No	enum	BANK_CARD SBP CRYPTO	BANK_CARD	Account type to which funds are sent
AccountNumber	No	string		220220******7046	Account identifier depending on AccountType: BANK_CARD - card number QIWI - phone number
BalanceAmount	No	decimal		3150.00	Amount debited from the balance
BalanceCommission	No	decimal		150.00	System commission, in the balance currency
BalanceCurrency	No	enum	USD RUB EUR	RUB	Balance currency
CommissionApplyType	No	enum	sender recipient	sender	Who paid the commission
SignatureValue	Yes	string		DC32D403CE6BD2E54D4D213278DB286C	Request signature. Formed as follows: `strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))`

Request example


            curl -X POST 'https://cardlink.link/callback/payout/success' \

                                                            -d 'TrsId=ZqmawDQ9B7l'  \
                                    -d 'Amount=50010.00000000'  \
                                    -d 'IsAuto=false'  \
                                    -d 'Status=SUCCESS'  \
                                    -d 'Currency=RUB'  \
                                    -d 'Commission=10.00000000'  \
                                    -d 'AccountType=QIWI'  \
                                    -d 'AccountNumber=+79999999999'  \
                                    -d 'BalanceAmount=50010.00000000'  \
                                    -d 'SignatureValue=5FC958AE222AF2E49881DEB815B8E8A2'  \
                                    -d 'BalanceCurrency=RUB'  \
                                    -d 'BalanceCommission=10.00000000'  \
                                    -d 'CommissionApplyType=sender'

As a result of a refund execution, if the Refund URL is specified in the shop settings, a POST request is sent with information about the refund.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
Id	Yes	string		LXZv3R7Q8B	Unique refund identifier
Amount	Yes	decimal		3150.00	Refund amount
Currency	Yes	enum	USD RUB EUR USDT	RUB	The currency in which the refund is made
Status	Yes	enum	SUCCESS FAIL	SUCCESS	Refund status
InvId	Yes	string		payment-19238465	Unique order identifier passed when generating the invoice for which the refund is being performed
BillId	Yes	string		KSvv3R7123	Unique bill identifier
PaymentId	Yes	string		QSvv3R7123	Unique payment identifier for which a refund occurred
SignatureValue	Yes	string		DC32D403CE6BD2E54D4D213278DB286C	Request signature. Formed as follows: `strtoupper(md5($Amount . ":" . $Currency . ":" . $BillId . ":" . $PaymentId . ":". $Id . ":" . $apiToken))`

Request example


            curl -X POST 'https://cardlink.link/callback/refund/success' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'Id=ZqmawDQ9B7l'  \
                                    -d 'Amount=50010.00000000'  \
                                    -d 'Currency=RUB'  \
                                    -d 'Status=SUCCESS'  \
                                    -d 'InvId=payment-19238465'  \
                                    -d 'BillId=KSvv3R7123'  \
                                    -d 'PaymentId=QSvv3R7123'  \
                                    -d 'SignatureValue=5FC958AE222AF2E49881DEB815B8E8A2'

As a result of a chargeback, if the Chargeback URL is specified in the shop settings, a POST request with chargeback information is sent.

Request parameters

Parameter name	Required parameter	Type	Possible values	Example	Description
Id	Yes	string		LXZv3R7Q8B	Unique chargeback identifier
Status	Yes	enum	SUCCESS FAIL	SUCCESS	Chargeback status
InvId	Yes	string		payment-19238465	Unique order identifier passed when generating the invoice for which the chargeback is being performed
BillId	Yes	string		KSvv3R7123	Unique bill identifier
PaymentId	Yes	string		QSvv3R7123	Unique payment identifier for which a chargeback occurred
SignatureValue	Yes	string		DC32D403CE6BD2E54D4D213278DB286C	Request signature. Formed as follows: `strtoupper(md5($BillId . ":". $PaymentId . ":". $Id . ":" . $apiToken))`

Request example


            curl -X POST 'https://cardlink.link/callback/chargeback/success' \

                        -H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
                                                            -d 'Id=ZqmawDQ9B7l'  \
                                    -d 'Status=SUCCESS'  \
                                    -d 'InvId=payment-19238465'  \
                                    -d 'BillId=KSvv3R7123'  \
                                    -d 'PaymentId=QSvv3R7123'  \
                                    -d 'SignatureValue=5FC958AE222AF2E49881DEB815B8E8A2'

Parameter name	Type	Format	Possible values	Example	Description
prev	string			https://cardlink.shop/api/v1/search?cursor=eyJpZCI6NzY1LCJf	Link to the previous page
next	string			https://cardlink.shop/api/v1/search?cursor=eyJpZCI6NzU2LCJd	Link to the next page

Parameter name	Type	Example	Description
path	string	https://cardlink.shop/api/v1/search	Link to the page without a cursor
per_page	integer	1000	Number of items per page
prev_cursor	string	eyJpZCI6NzU2LCJfcG9pbnRzVG9O	Pointer to the previous page
next_cursor	string	eyJpZCI6NzY1LCJfcG9pbnRzVG91	Pointer to the next page

How to get started?

Bill

Payment

Balance

Payout

Refund

Postback

Additional

How to get started?

Bill

Payment

Balance

Payout

Refund

Postback

Additional