Skip to content

API integration

How to get started?

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

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 '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.link/link/3P1p2rgW7Y",
  "link_page_url": "https://cardlink.link/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"
}

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 Type Description Possible values Example
InvId required string order_id field passed when creating the bill payment-19238465
OutSum required decimal Payment amount 380.55
CurrencyIn required enum The currency in which the bill was paid USD RUB EUR RUB
custom string Custom field, passed when creating a bill additional_information
  • InvId string required
    order_id field passed when creating the bill
    Example: payment-19238465
  • OutSum decimal required
    Payment amount
    Example: 380.55
  • CurrencyIn enum required
    The currency in which the bill was paid
    Possible values: USD RUB EUR
    Example: RUB
  • custom string
    Custom field, passed when creating a bill
    Example: additional_information

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'

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 Type Description Possible values Example
InvId required string order_id field passed when creating the bill payment-19238465
OutSum required decimal Payment amount 380.55
CurrencyIn required enum The currency in which the bill was paid USD RUB EUR RUB
custom string Custom field, passed when creating a bill additional_information
  • InvId string required
    order_id field passed when creating the bill
    Example: payment-19238465
  • OutSum decimal required
    Payment amount
    Example: 380.55
  • CurrencyIn enum required
    The currency in which the bill was paid
    Possible values: USD RUB EUR
    Example: RUB
  • custom string
    Custom field, passed when creating a bill
    Example: additional_information

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'

Bill

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

Important: do not pass empty strings ("") or the string "NULL" in any field. If data is unavailable — exclude the field entirely from the request.
Parameter name Type Description Possible values Example
name string Name of the product or service Steam
price decimal Price per unit as a string with two decimal places (e.g. 500.00) 500.00
quantity decimal Item quantity as a string (e.g. 1) 1
category string Internal product category. Examples: steam, digital/stars, digital/subscription/xbox, digital/subscription/netflix steam
extra array Object with account identifier associated with the purchase. Required fields depend on the product category. Omit entirely if no data is available — do not pass empty or null values. {"steam_account": "jordas123"}
extra[steam_account] string Steam account login for the top-up. Required for Steam balance top-up items. jordas123
extra[telegram_username] string Telegram account username for Stars top-up (e.g. DurovunaDR). Required for both website and Telegram bot sales. DurovunaDR
extra[telegram_id] string Numeric Telegram account ID (e.g. 5099904440). Required only when selling via Telegram bot. 5099904440
extra[account] string Account or email to which the service will be activated (e.g. user@example.com). Pass only when data is available. user@example.com
  • name string
    Name of the product or service
    Example: Steam
  • price decimal
    Price per unit as a string with two decimal places (e.g. 500.00)
    Example: 500.00
  • quantity decimal
    Item quantity as a string (e.g. 1)
    Example: 1
  • category string
    Internal product category. Examples: steam, digital/stars, digital/subscription/xbox, digital/subscription/netflix
    Example: steam
  • extra array
    Object with account identifier associated with the purchase. Required fields depend on the product category. Omit entirely if no data is available — do not pass empty or null values.
    Example: {"steam_account": "jordas123"}
  • extra[steam_account] string
    Steam account login for the top-up. Required for Steam balance top-up items.
    Example: jordas123
  • extra[telegram_username] string
    Telegram account username for Stars top-up (e.g. DurovunaDR). Required for both website and Telegram bot sales.
    Example: DurovunaDR
  • extra[telegram_id] string
    Numeric Telegram account ID (e.g. 5099904440). Required only when selling via Telegram bot.
    Example: 5099904440
  • extra[account] string
    Account or email to which the service will be activated (e.g. user@example.com). Pass only when data is available.
    Example: user@example.com

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 Type Description Possible values Example
amount required decimal Bill amount 380.99
shop_id required string Unique identifier of the shop the payment belongs to. Without this parameter, Success URL, Fail URL and Result URL will not work LXZv3R7Q8B
order_id string Unique identifier of the order. Will be returned in postback. order-285394168
description string Payment description Order #285394168
type enum Bill type. NORMAL (one-time) or MULTI (reusable). If NORMAL is selected, you will not be able to pay a second time. normal multi normal
locale enum Locale, the language in which the payment form will be displayed en ru en
currency_in enum 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. RUB USD EUR RUB
account_currency enum The currency of the balance to which the payment should be credited. If not passed, the account currency is determined automatically. RUB USD EUR RUB
custom string Custom field. Will be returned in postback. my-custom-string
payer_pays_commission enum Parameter that specifies who will pay the commission for the incoming payment. 1 0 1
payer_data[phone] string Payer's phone number. +79991234567
payer_data[email] string Parameter that fills in the client's email on the payment page. payer@email.com
name string Link name. Specify what you are accepting funds for. This text will be displayed in the payment form. Donation
ttl integer Bill lifetime in seconds. 600
return_url string URL for the "Return to shop" link on the payment page. The domain must match the one specified when adding the shop to the system https://exmpl.com/return
success_url string Successful payment page. https://exmpl.com/order-285394168/success
fail_url string Failed payment page. https://exmpl.com/order-285394168/fail
payment_method enum 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. BANK_CARD SBP SBP
request_fields[email] boolean If this parameter is specified, payer must fill in the email false
request_fields[phone] boolean If this parameter is specified, payer must fill in the phone number false
request_fields[name] boolean If this parameter is specified, payer must fill in the name false
request_fields[comment] boolean If this parameter is specified, payer must fill in the comment false
items array Array of bill items Order Item Resource
show_converted_amount boolean Flag for showing the amount converted to the account currency on the payment form when the bill currency differs from the account currency. true
notification[mail] boolean Flag for sending an email notification to the merchant when the bill status changes. true
deactivate_on_fail boolean Deactivate the bill after the first failed payment: no new payment attempts via the link are possible. When the parameter is omitted, the shop setting applies — support enables it on request. The parameter has no effect on bills of type multi. false
  • amount decimal required
    Bill amount
    Example: 380.99
  • shop_id string required
    Unique identifier of the shop the payment belongs to. Without this parameter, Success URL, Fail URL and Result URL will not work
    Example: LXZv3R7Q8B
  • order_id string
    Unique identifier of the order. Will be returned in postback.
    Example: order-285394168
  • description string
    Payment description
    Example: Order #285394168
  • type enum
    Bill type. NORMAL (one-time) or MULTI (reusable). If NORMAL is selected, you will not be able to pay a second time.
    Possible values: normal multi
    Example: normal
  • locale enum
    Locale, the language in which the payment form will be displayed
    Possible values: en ru
    Example: en
  • currency_in enum
    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.
    Possible values: RUB USD EUR
    Example: RUB
  • account_currency enum
    The currency of the balance to which the payment should be credited. If not passed, the account currency is determined automatically.
    Possible values: RUB USD EUR
    Example: RUB
  • custom string
    Custom field. Will be returned in postback.
    Example: my-custom-string
  • payer_pays_commission enum
    Parameter that specifies who will pay the commission for the incoming payment.
    Possible values: 1 0
    Example: 1
  • payer_data[phone] string
    Payer's phone number.
    Example: +79991234567
  • payer_data[email] string
    Parameter that fills in the client's email on the payment page.
    Example: payer@email.com
  • name string
    Link name. Specify what you are accepting funds for. This text will be displayed in the payment form.
    Example: Donation
  • ttl integer
    Bill lifetime in seconds.
    Example: 600
  • return_url string
    URL for the "Return to shop" link on the payment page. The domain must match the one specified when adding the shop to the system
    Example: https://exmpl.com/return
  • success_url string
    Successful payment page.
    Example: https://exmpl.com/order-285394168/success
  • fail_url string
    Failed payment page.
    Example: https://exmpl.com/order-285394168/fail
  • payment_method enum
    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.
    Possible values: BANK_CARD SBP
    Example: SBP
  • request_fields[email] boolean
    If this parameter is specified, payer must fill in the email
    Example: false
  • request_fields[phone] boolean
    If this parameter is specified, payer must fill in the phone number
    Example: false
  • request_fields[name] boolean
    If this parameter is specified, payer must fill in the name
    Example: false
  • request_fields[comment] boolean
    If this parameter is specified, payer must fill in the comment
    Example: false
  • items array
    Array of bill items
  • show_converted_amount boolean
    Flag for showing the amount converted to the account currency on the payment form when the bill currency differs from the account currency.
    Example: true
  • notification[mail] boolean
    Flag for sending an email notification to the merchant when the bill status changes.
    Example: true
  • deactivate_on_fail boolean
    Deactivate the bill after the first failed payment: no new payment attempts via the link are possible. When the parameter is omitted, the shop setting applies — support enables it on request. The parameter has no effect on bills of type multi.
    Example: false

Response parameters

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

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' \
-d 'account_currency=RUB'

Response example

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

Possible errors

Response code Error key Error description
400 api:error.transaction_rejected Transaction rejected
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.access_denied Merchant does not have access to the shop
403 api:error.ip_access_denied Request IP is not in whitelist
403 api:error.rate-not-found Rate not available
422 Input data validation error
500 api:error.general_error Internal error
503 api:error.payment_method_temporarily_unavailable The payment method is temporarily unavailable (processing circuit breaker is open); retry after the number of seconds from the Retry-After header

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 Type Description Possible values Example
id required string Unique bill identifier LXZv3R7Q8B
active required boolean 0 - deactivate bill, 1 - activate bill 0 1 0
  • id string required
    Unique bill identifier
    Example: LXZv3R7Q8B
  • active boolean required
    0 - deactivate bill, 1 - activate bill
    Possible values: 0 1
    Example: 0

Response parameters

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

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 Type Description Possible values Example
id required string Unique bill identifier LXZv3R7Q8B
per_page integer Number of items per page 50
cursor string Pointer to page eyJpZCI6NzY1LCJfcG
  • id string required
    Unique bill identifier
    Example: LXZv3R7Q8B
  • per_page integer
    Number of items per page
    Example: 50
  • cursor string
    Pointer to page
    Example: eyJpZCI6NzY1LCJfcG

Response parameters

Parameter name Type Description Possible values Example
success boolean Request success flag true false true
data array Payment Array of payments related to this bill See description Payment
links array Links Pagination Links See Pagination Links
meta array Meta Pagination Meta Data See description Pagination Meta
  • success boolean
    Request success flag
    Possible values: true false
    Example: true
  • data array, Payment
    Array of payments related to this bill
    Example: See description Payment
  • links array, Links
    Pagination Links
    Example: See Pagination Links
  • meta array, Meta
    Pagination Meta Data
    Example: See description Pagination Meta

Request example

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

Response example

{
    "success": true,
    "data": [
        {
            "id": "PQX2XD25a0",
            "bill_id": "LXZv3R7Q8B",
            "bill_order_id": "order-285394171",
            "status": "SUCCESS",
            "amount": 35400,
            "bill_amount": 35400,
            "commission": 400,
            "account_amount": 35000,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "676454******7272",
            "account_bank": "SBERBANK",
            "currency_in": "RUB",
            "created_at": "2020-10-19 17:00:00"
        },
        {
            "id": "zeAmwP2d5Q",
            "bill_id": "LXZv3R7Q8B",
            "bill_order_id": "order-285394171",
            "status": "NEW",
            "amount": 3200,
            "bill_amount": 3200,
            "commission": 50,
            "account_amount": 3150,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "676454******7272",
            "account_bank": "SBERBANK",
            "currency_in": "RUB",
            "created_at": "2020-10-18 17:00:00"
        },
        {
            "id": "NDa7lNmdzx",
            "bill_id": "LXZv3R7Q8B",
            "bill_order_id": "order-285394171",
            "status": "FAIL",
            "amount": 26100,
            "bill_amount": 26100,
            "commission": 100,
            "account_amount": 26000,
            "account_currency_code": "RUB",
            "refunded_amount": 0,
            "from_card": "553691******4442",
            "account_bank": "TINKOFF",
            "currency_in": "RUB",
            "created_at": "2020-10-01 17:00:00"
        }
    ],
    "links": {
        "prev": "https://cardlink.link/api/v1/bill/payments?cursor=eyJpZCI6NzY1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOmZhbHNlfQ",
        "next": "https://cardlink.link/api/v1/bill/payments?cursor=eyJpZCI6NzU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    },
    "meta": {
        "path": "https://cardlink.link/api/v1/bill/payments",
        "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.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

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

Request parameters

Parameter name Type Description Possible values Example
id required string Unique bill identifier LXZv3R7Q8B
  • id string required
    Unique bill identifier
    Example: LXZv3R7Q8B

Response parameters

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

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.ip_access_denied Request IP is not in whitelist
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

Currencies

Returns a list of current exchange rates from sources available to your account. The set of sources and currency pairs is customizable.

Request parameters

No

Response parameters

Parameter name Type Description Possible values Example
success boolean Request success flag true false true
data array Object keyed by source name. Each value is an object keyed by source currency code, containing destination currency codes mapped to their rates. {"steam": {"USD": {"RUB": 100.50}}}
  • success boolean
    Request success flag
    Possible values: true false
    Example: true
  • data array
    Object keyed by source name. Each value is an object keyed by source currency code, containing destination currency codes mapped to their rates.
    Example: {"steam": {"USD": {"RUB": 100.50}}}

Request example

curl -X GET 'https://cardlink.link/api/v1/currencies/quote-rates' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT'

Response example

{
    "success": true,
    "data": {
        "first_exchange_rate": {
            "USD": {
                "RUB": 100.5
            }
        },
        "second_exchange_rate": {
            "USD": {
                "EUR": 0.92,
                "RUB": 100.5
            }
        }
    }
}

Possible errors

Response code Error key Error description
401 Unauthenticated Invalid API Token
400 api:error.access_denied Merchant does not have access to the shop
403 api:error.ip_access_denied Request IP is not in whitelist
500 api:error.general_error Internal error

Payment

Parameter name Type Description Possible values Example
id string Unique payment identifier jZqmaPvl9W
bill_id string Unique identifier of the bill to which the payment belongs do5G93m
bill_order_id string Unique identifier of the order. Will be returned in postback. order-285394168
status enum Payment status NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL NEW
amount decimal Payment amount 4039.65
bill_amount decimal Bill amount. Unlike amount, it does not include the commission passed on to the payer (payer_pays_commission) 4000.00
commission decimal Commission 39.65
account_amount decimal Amount credited to balance 4000.00
account_currency_code string Currency credited to balance RUB
refunded_amount decimal Sum of refunded amount 0
from_card string Card number from which payment was made (When paying by bank card) 671254******7272
account_bank string Payer account bank from which payment was made SBERBANK
currency_in enum The currency in which the bill is paid USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Date and time of payment creation 2024-12-19 17:32:55
payer_phone string Payer phone 79112223344
payer_email string Payer email payer@example.com
payer_name string Payer name Ivan
payer_comment string Payer comment Payment comment
error_code integer Error code 400
error_message string Error description Limits exceeded
description string Description Invoice #123123
rrn string Operation RRN 532100123456
payment_purpose string Payment purpose Invoice #123123 payment
  • id string
    Unique payment identifier
    Example: jZqmaPvl9W
  • bill_id string
    Unique identifier of the bill to which the payment belongs
    Example: do5G93m
  • bill_order_id string
    Unique identifier of the order. Will be returned in postback.
    Example: order-285394168
  • status enum
    Payment status
    Possible values: NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL
    Example: NEW
  • amount decimal
    Payment amount
    Example: 4039.65
  • bill_amount decimal
    Bill amount. Unlike amount, it does not include the commission passed on to the payer (payer_pays_commission)
    Example: 4000.00
  • commission decimal
    Commission
    Example: 39.65
  • account_amount decimal
    Amount credited to balance
    Example: 4000.00
  • account_currency_code string
    Currency credited to balance
    Example: RUB
  • refunded_amount decimal
    Sum of refunded amount
    Example: 0
  • from_card string
    Card number from which payment was made (When paying by bank card)
    Example: 671254******7272
  • account_bank string
    Payer account bank from which payment was made
    Example: SBERBANK
  • currency_in enum
    The currency in which the bill is paid
    Possible values: USD RUB EUR
    Example: RUB
  • created_at datetime, Y-m-d H:i:s
    Date and time of payment creation
    Example: 2024-12-19 17:32:55
  • payer_phone string
    Payer phone
    Example: 79112223344
  • payer_email string
    Payer email
    Example: payer@example.com
  • payer_name string
    Payer name
    Example: Ivan
  • payer_comment string
    Payer comment
    Example: Payment comment
  • error_code integer
    Error code
    Example: 400
  • error_message string
    Error description
    Example: Limits exceeded
  • description string
    Description
    Example: Invoice #123123
  • rrn string
    Operation RRN
    Example: 532100123456
  • payment_purpose string
    Payment purpose
    Example: Invoice #123123 payment

Parameter name Type Description Possible values Example
id string Chargeback ID jZqmaPvl9W
payment_id string Payment ID do5G93m
status enum Status NEW PROCESS SUCCESS FAIL NEW
created_at datetime Y-m-d H:i:s Created at 2024-12-19 17:32:55
  • id string
    Chargeback ID
    Example: jZqmaPvl9W
  • payment_id string
    Payment ID
    Example: do5G93m
  • status enum
    Status
    Possible values: NEW PROCESS SUCCESS FAIL
    Example: NEW
  • created_at datetime, Y-m-d H:i:s
    Created at
    Example: 2024-12-19 17:32:55

Request parameters

Parameter name Type Description Possible values Example
id required string Unique payment identifier LXZv3R7Q8B
refunds boolean Include refund information in the response 1
chargeback boolean Include chargeback information in the response 0
  • id string required
    Unique payment identifier
    Example: LXZv3R7Q8B
  • refunds boolean
    Include refund information in the response
    Example: 1
  • chargeback boolean
    Include chargeback information in the response
    Example: 0

Response parameters

Parameter name Type Description Possible values Example
id string Unique payment identifier jZqmaPvl9W
bill_id string Unique identifier of the bill to which the payment belongs do5G93m
bill_order_id string Unique identifier of the order. Will be returned in postback. order-285394168
status enum Payment status NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL NEW
amount decimal Payment amount 4039.65
bill_amount decimal Bill amount. Unlike amount, it does not include the commission passed on to the payer (payer_pays_commission) 4000.00
commission decimal Commission 39.65
account_amount decimal Amount credited to balance 4000.00
account_currency_code string Currency credited to balance RUB
refunded_amount decimal Sum of refunded amount 0
from_card string Card number from which payment was made (When paying by bank card) 671254******7272
account_bank string Payer account bank from which payment was made SBERBANK
currency_in enum The currency in which the bill is paid USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Date and time of payment creation 2024-12-19 17:32:55
payer_phone string Payer phone 79112223344
payer_email string Payer email payer@example.com
payer_name string Payer name Ivan
payer_comment string Payer comment Payment comment
error_code integer Error code 400
error_message string Error description Limits exceeded
description string Description Invoice #123123
rrn string Operation RRN 532100123456
payment_purpose string Payment purpose Invoice #123123 payment
success boolean Request success flag true false true
refunds array Refund Array of refunds. Returned if refunds=true was provided [Refund Resource]
chargeback array Chargeback Chargeback information. Returned if it exists and chargeback=true was provided Chargeback Resource
  • id string
    Unique payment identifier
    Example: jZqmaPvl9W
  • bill_id string
    Unique identifier of the bill to which the payment belongs
    Example: do5G93m
  • bill_order_id string
    Unique identifier of the order. Will be returned in postback.
    Example: order-285394168
  • status enum
    Payment status
    Possible values: NEW PROCESS UNDERPAID SUCCESS OVERPAID FAIL
    Example: NEW
  • amount decimal
    Payment amount
    Example: 4039.65
  • bill_amount decimal
    Bill amount. Unlike amount, it does not include the commission passed on to the payer (payer_pays_commission)
    Example: 4000.00
  • commission decimal
    Commission
    Example: 39.65
  • account_amount decimal
    Amount credited to balance
    Example: 4000.00
  • account_currency_code string
    Currency credited to balance
    Example: RUB
  • refunded_amount decimal
    Sum of refunded amount
    Example: 0
  • from_card string
    Card number from which payment was made (When paying by bank card)
    Example: 671254******7272
  • account_bank string
    Payer account bank from which payment was made
    Example: SBERBANK
  • currency_in enum
    The currency in which the bill is paid
    Possible values: USD RUB EUR
    Example: RUB
  • created_at datetime, Y-m-d H:i:s
    Date and time of payment creation
    Example: 2024-12-19 17:32:55
  • payer_phone string
    Payer phone
    Example: 79112223344
  • payer_email string
    Payer email
    Example: payer@example.com
  • payer_name string
    Payer name
    Example: Ivan
  • payer_comment string
    Payer comment
    Example: Payment comment
  • error_code integer
    Error code
    Example: 400
  • error_message string
    Error description
    Example: Limits exceeded
  • description string
    Description
    Example: Invoice #123123
  • rrn string
    Operation RRN
    Example: 532100123456
  • payment_purpose string
    Payment purpose
    Example: Invoice #123123 payment
  • success boolean
    Request success flag
    Possible values: true false
    Example: true
  • refunds array, Refund
    Array of refunds. Returned if refunds=true was provided
    Example: [Refund Resource]
  • chargeback array, Chargeback
    Chargeback information. Returned if it exists and chargeback=true was provided

Request example

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

Response example

{
    "id": "PQX2XD25a0",
    "bill_id": "do5G93m",
    "bill_order_id": "order-285394168",
    "status": "SUCCESS",
    "amount": 35400,
    "bill_amount": 35400,
    "commission": 400,
    "account_amount": 35000,
    "account_currency_code": "RUB",
    "refunded_amount": 0,
    "from_card": "676454******7272",
    "account_bank": "SBERBANK",
    "currency_in": "RUB",
    "description": "Invoice #123123",
    "created_at": "2025-10-19 17:00:00",
    "success": true,
    "refunds": [],
    "chargeback": []
}

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.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_not_found Merchant not found
403 api:error.payment_not_found Payment not found
422 Input data validation error

Balance

Parameter name Type Description Possible values Example
currency enum Balance currency USD RUB EUR RUB
balance_available decimal Available balance 93988.37000000
balance_locked decimal Blocked balance during payout 0.00000000
balance_hold decimal Temporarily held balance. Becomes available after some time 0.00000000
balance_min decimal Spending threshold. Above zero is a minimum balance, below zero is an allowed overdraft, 0 means no threshold 0.00000000
balance_spendable decimal Spendable amount: the balance minus the spending threshold. May be below zero 93988.37000000
  • currency enum
    Balance currency
    Possible values: USD RUB EUR
    Example: RUB
  • balance_available decimal
    Available balance
    Example: 93988.37000000
  • balance_locked decimal
    Blocked balance during payout
    Example: 0.00000000
  • balance_hold decimal
    Temporarily held balance. Becomes available after some time
    Example: 0.00000000
  • balance_min decimal
    Spending threshold. Above zero is a minimum balance, below zero is an allowed overdraft, 0 means no threshold
    Example: 0.00000000
  • balance_spendable decimal
    Spendable amount: the balance minus the spending threshold. May be below zero
    Example: 93988.37000000

Request parameters

No

Response parameters

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

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",
            "balance_min": "0.00000000",
            "balance_spendable": "93988.37000000"
        }
    ],
    "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.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_not_found Merchant not found
403 api:error.merchant_banned Merchant is banned
422 Input data validation error

Payout

Parameter name Type Description Possible values Example
id string Unique payout identifier LXZv3R7Q8B
status enum Payout status NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED NEW
order_id string Unique order identifier payout-19238465
account_identifier string Payment account to which the payout is made, without a mask: full card number, full phone number; crypto - network and full wallet address as network:address 2202201234567046
account_bank string Recipient bank. Present for cards and SBP when the bank is known Sberbank
amount decimal 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 4000
account_amount decimal Amount debited from the balance 4039.65
commission decimal Service commission 39.65
account_commission decimal Service commission in balance currency 39.65
currency enum Payout currency USD RUB EUR RUB
account_currency enum Balance currency USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Date and time of payout creation 2024-12-19 17:32:55
error_code integer Error code 400
error_message string Error Description Limits exceeded
  • id string
    Unique payout identifier
    Example: LXZv3R7Q8B
  • status enum
    Payout status
    Possible values: NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED
    Example: NEW
  • order_id string
    Unique order identifier
    Example: payout-19238465
  • account_identifier string
    Payment account to which the payout is made, without a mask: full card number, full phone number; crypto - network and full wallet address as network:address
    Example: 2202201234567046
  • account_bank string
    Recipient bank. Present for cards and SBP when the bank is known
    Example: Sberbank
  • amount decimal
    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
    Example: 4000
  • account_amount decimal
    Amount debited from the balance
    Example: 4039.65
  • commission decimal
    Service commission
    Example: 39.65
  • account_commission decimal
    Service commission in balance currency
    Example: 39.65
  • currency enum
    Payout currency
    Possible values: USD RUB EUR
    Example: RUB
  • account_currency enum
    Balance currency
    Possible values: USD RUB EUR
    Example: RUB
  • created_at datetime, Y-m-d H:i:s
    Date and time of payout creation
    Example: 2024-12-19 17:32:55
  • error_code integer
    Error code
    Example: 400
  • error_message string
    Error Description
    Example: Limits exceeded

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

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 Type Description Possible values Example
amount required decimal Payout amount 380.99
payout_account_id required string Unique identifier of the payment account to which the payout will be made. LXZv3R7Q8B
currency enum Currency of the payout the amount is specified in. USD RUB EUR USDT RUB
account_currency enum The currency of the balance from which the funds for the payout should be debited. USD RUB EUR RUB
recipient_pays_commission boolean 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) true false false
order_id string Unique order identifier. payout-384685192
  • amount decimal required
    Payout amount
    Example: 380.99
  • payout_account_id string required
    Unique identifier of the payment account to which the payout will be made.
    Example: LXZv3R7Q8B
  • currency enum
    Currency of the payout the amount is specified in.
    Possible values: USD RUB EUR USDT
    Example: RUB
  • account_currency enum
    The currency of the balance from which the funds for the payout should be debited.
    Possible values: USD RUB EUR
    Example: RUB
  • recipient_pays_commission boolean
    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)
    Possible values: true false
    Example: false
  • order_id string
    Unique order identifier.
    Example: payout-384685192

Response parameters

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

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": "6764540000007272",
            "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 funds for payout. errors.balance holds the actual balance, errors.available holds the amount spendable with the threshold applied
400 api:error.direction_not_available Payout for this account is not available
400 api:error.merchant_not_verified Merchant is not verified
400 api:error.rub_payout_offer_not_accepted The account owner has not accepted the RUB payout offer: payouts to Russian cards and via SBP are unavailable until it is accepted in the merchant account
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 Type Description Possible values Example
amount required decimal Payout amount 380.99
currency required enum Currency USD RUB EUR RUB
account_type required enum The type of account to which the funds are sent credit_card sbp crypto steam credit_card
account_identifier required string Account identifier depending on account_type:
credit_card - card number
sbp - phone number
crypto - wallet address
steam - user\`s Steam login
+79123456789
account_bank required integer Bank member ID for account_type=sbp. You can get a list of available banks in this section 100000000032
card_holder required string Cardholder for account_type=credit_card. As indicated on the card. IVAN IVANOV
account_network required string Network for sending cryptocurrency/tokens for account_type=crypto. TRX - Tron network, ETH - Ethereum. TRX ETH TRX
account_currency enum Balance currency USD RUB EUR RUB
recipient_pays_commission boolean 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) true false false
order_id string Unique order identifier. payout-384685192
  • amount decimal required
    Payout amount
    Example: 380.99
  • currency enum required
    Currency
    Possible values: USD RUB EUR
    Example: RUB
  • account_type enum required
    The type of account to which the funds are sent
    Possible values: credit_card sbp crypto steam
    Example: credit_card
  • account_identifier string required
    Account identifier depending on account_type:
    credit_card - card number
    sbp - phone number
    crypto - wallet address
    steam - user\`s Steam login
    Example: +79123456789
  • account_bank integer required
    Bank member ID for account_type=sbp. You can get a list of available banks in this section
    Example: 100000000032
  • card_holder string required
    Cardholder for account_type=credit_card. As indicated on the card.
    Example: IVAN IVANOV
  • account_network string required
    Network for sending cryptocurrency/tokens for account_type=crypto. TRX - Tron network, ETH - Ethereum.
    Possible values: TRX ETH
    Example: TRX
  • account_currency enum
    Balance currency
    Possible values: USD RUB EUR
    Example: RUB
  • recipient_pays_commission boolean
    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)
    Possible values: true false
    Example: false
  • order_id string
    Unique order identifier.
    Example: payout-384685192

Response parameters

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

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": "4242424242424242",
            "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 funds for payout. errors.balance holds the actual balance, errors.available holds the amount spendable with the threshold applied
400 api:error.direction_not_available Payout for this account is not available
400 api:error.merchant_not_verified Merchant is not verified
400 api:error.rub_payout_offer_not_accepted The account owner has not accepted the RUB payout offer: payouts to Russian cards and via SBP are unavailable until it is accepted in the merchant account
403 This action is unauthorized Merchant is not verified
422 Input data validation error
422 api:error.validation A payout with this order_id already exists: errors contains only the order_id key
500 api:error.general_error Internal error

Cancels a payout that is awaiting moderation (MODERATING status). The locked amount is returned to the available balance. Payouts in any other status cannot be cancelled.

Request parameters

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

Response parameters

Parameter name Type Description Possible values Example
id string Unique payout identifier LXZv3R7Q8B
status enum Payout status NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED NEW
order_id string Unique order identifier payout-19238465
account_identifier string Payment account to which the payout is made, without a mask: full card number, full phone number; crypto - network and full wallet address as network:address 2202201234567046
account_bank string Recipient bank. Present for cards and SBP when the bank is known Sberbank
amount decimal 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 4000
account_amount decimal Amount debited from the balance 4039.65
commission decimal Service commission 39.65
account_commission decimal Service commission in balance currency 39.65
currency enum Payout currency USD RUB EUR RUB
account_currency enum Balance currency USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Date and time of payout creation 2024-12-19 17:32:55
error_code integer Error code 400
error_message string Error Description Limits exceeded
success boolean Request success flag true false true
  • id string
    Unique payout identifier
    Example: LXZv3R7Q8B
  • status enum
    Payout status
    Possible values: NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED
    Example: NEW
  • order_id string
    Unique order identifier
    Example: payout-19238465
  • account_identifier string
    Payment account to which the payout is made, without a mask: full card number, full phone number; crypto - network and full wallet address as network:address
    Example: 2202201234567046
  • account_bank string
    Recipient bank. Present for cards and SBP when the bank is known
    Example: Sberbank
  • amount decimal
    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
    Example: 4000
  • account_amount decimal
    Amount debited from the balance
    Example: 4039.65
  • commission decimal
    Service commission
    Example: 39.65
  • account_commission decimal
    Service commission in balance currency
    Example: 39.65
  • currency enum
    Payout currency
    Possible values: USD RUB EUR
    Example: RUB
  • account_currency enum
    Balance currency
    Possible values: USD RUB EUR
    Example: RUB
  • created_at datetime, Y-m-d H:i:s
    Date and time of payout creation
    Example: 2024-12-19 17:32:55
  • error_code integer
    Error code
    Example: 400
  • error_message string
    Error Description
    Example: Limits exceeded
  • success boolean
    Request success flag
    Possible values: true false
    Example: true

Request example

curl -X POST 'https://cardlink.link/api/v1/payout/cancel' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'id=lGPmp4mYeE'

Response example

{
    "id": "lGPmp4mYeE",
    "status": "DECLINED",
    "amount": 1600,
    "commission": 100,
    "account_identifier": "6764540000007272",
    "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
400 api:error.payout_cannot_be_cancelled The payout cannot be cancelled in its current status. Only payouts awaiting moderation can be cancelled
403 api:error.access_denied Merchant does not have access to the shop
403 api:error.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_not_found Merchant not found
422 api:error.validation Payout not found
500 api:error.general_error Internal error

Request parameters

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

Response parameters

Parameter name Type Description Possible values Example
id string Unique payout identifier LXZv3R7Q8B
status enum Payout status NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED NEW
order_id string Unique order identifier payout-19238465
account_identifier string Payment account to which the payout is made, without a mask: full card number, full phone number; crypto - network and full wallet address as network:address 2202201234567046
account_bank string Recipient bank. Present for cards and SBP when the bank is known Sberbank
amount decimal 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 4000
account_amount decimal Amount debited from the balance 4039.65
commission decimal Service commission 39.65
account_commission decimal Service commission in balance currency 39.65
currency enum Payout currency USD RUB EUR RUB
account_currency enum Balance currency USD RUB EUR RUB
created_at datetime Y-m-d H:i:s Date and time of payout creation 2024-12-19 17:32:55
error_code integer Error code 400
error_message string Error Description Limits exceeded
success boolean Request success flag true false true
  • id string
    Unique payout identifier
    Example: LXZv3R7Q8B
  • status enum
    Payout status
    Possible values: NEW MODERATING PROCESS SUCCESS FAIL ERROR DECLINED
    Example: NEW
  • order_id string
    Unique order identifier
    Example: payout-19238465
  • account_identifier string
    Payment account to which the payout is made, without a mask: full card number, full phone number; crypto - network and full wallet address as network:address
    Example: 2202201234567046
  • account_bank string
    Recipient bank. Present for cards and SBP when the bank is known
    Example: Sberbank
  • amount decimal
    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
    Example: 4000
  • account_amount decimal
    Amount debited from the balance
    Example: 4039.65
  • commission decimal
    Service commission
    Example: 39.65
  • account_commission decimal
    Service commission in balance currency
    Example: 39.65
  • currency enum
    Payout currency
    Possible values: USD RUB EUR
    Example: RUB
  • account_currency enum
    Balance currency
    Possible values: USD RUB EUR
    Example: RUB
  • created_at datetime, Y-m-d H:i:s
    Date and time of payout creation
    Example: 2024-12-19 17:32:55
  • error_code integer
    Error code
    Example: 400
  • error_message string
    Error Description
    Example: Limits exceeded
  • success boolean
    Request success flag
    Possible values: true false
    Example: true

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": "6764540000007272",
    "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.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_not_found Merchant not found
422 api:error.validation Payout not found: errors contains the id or order_id key, depending on the parameter passed
422 api:error.validation Input data validation error

Request parameters

No

Response parameters

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

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.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_not_found Merchant not found
422 Input data validation error

Refund

Parameter name Type Description Possible values Example
id string Unique Refund ID 5QWlqB2kKJ
status string Refund Status NEW PROCESS SUCCESS FAIL NEW
amount decimal Refund Amount 1355.91
currency enum Currency USD RUB EUR RUB
entity_type string Refund Type payment payment
entity_id string Unique identifier of the payment being refunded LXZv3R7Q8B
operation_id string Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Date and time the refund was created 2024-12-19 17:32:55
  • id string
    Unique Refund ID
    Example: 5QWlqB2kKJ
  • status string
    Refund Status
    Possible values: NEW PROCESS SUCCESS FAIL
    Example: NEW
  • amount decimal
    Refund Amount
    Example: 1355.91
  • currency enum
    Currency
    Possible values: USD RUB EUR
    Example: RUB
  • entity_type string
    Refund Type
    Possible values: payment
    Example: payment
  • entity_id string
    Unique identifier of the payment being refunded
    Example: LXZv3R7Q8B
  • operation_id string
    Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments
    Example: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Date and time the refund was created
    Example: 2024-12-19 17:32:55

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

Request parameters

Parameter name Type Description Possible values Example
payment_id required string Unique Payment ID LXZv3R7Q8B
order_id string Order ID on your side. Will be returned in postback. fa982948-c58a-4fc0-a62d-a5125c907766
  • payment_id string required
    Unique Payment ID
    Example: LXZv3R7Q8B
  • order_id string
    Order ID on your side. Will be returned in postback.
    Example: fa982948-c58a-4fc0-a62d-a5125c907766

Response parameters

Parameter name Type Description Possible values Example
id string Unique Refund ID 5QWlqB2kKJ
status string Refund Status NEW PROCESS SUCCESS FAIL NEW
amount decimal Refund Amount 1355.91
currency enum Currency USD RUB EUR RUB
entity_type string Refund Type payment payment
entity_id string Unique identifier of the payment being refunded LXZv3R7Q8B
operation_id string Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Date and time the refund was created 2024-12-19 17:32:55
success boolean Request success flag true false true
  • id string
    Unique Refund ID
    Example: 5QWlqB2kKJ
  • status string
    Refund Status
    Possible values: NEW PROCESS SUCCESS FAIL
    Example: NEW
  • amount decimal
    Refund Amount
    Example: 1355.91
  • currency enum
    Currency
    Possible values: USD RUB EUR
    Example: RUB
  • entity_type string
    Refund Type
    Possible values: payment
    Example: payment
  • entity_id string
    Unique identifier of the payment being refunded
    Example: LXZv3R7Q8B
  • operation_id string
    Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments
    Example: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Date and time the refund was created
    Example: 2024-12-19 17:32:55
  • success boolean
    Request success flag
    Possible values: true false
    Example: true

Request example

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

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
400 api:error.balance_not_enough Insufficient balance for payout
400 api:error.refund_tariff_not_found Refund tariff is not configured for shop
401 Unauthenticated Invalid API Token
403 api:error.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_banned Merchant is banned
403 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 Type Description Possible values Example
payment_id required string Unique Payment ID LXZv3R7Q8B
amount required decimal Partial Refund Amount 1355.91
order_id string Order ID on your side. Will be returned in postback. fa982948-c58a-4fc0-a62d-a5125c907766
  • payment_id string required
    Unique Payment ID
    Example: LXZv3R7Q8B
  • amount decimal required
    Partial Refund Amount
    Example: 1355.91
  • order_id string
    Order ID on your side. Will be returned in postback.
    Example: fa982948-c58a-4fc0-a62d-a5125c907766

Response parameters

Parameter name Type Description Possible values Example
id string Unique Refund ID 5QWlqB2kKJ
status string Refund Status NEW PROCESS SUCCESS FAIL NEW
amount decimal Refund Amount 1355.91
currency enum Currency USD RUB EUR RUB
entity_type string Refund Type payment payment
entity_id string Unique identifier of the payment being refunded LXZv3R7Q8B
operation_id string Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Date and time the refund was created 2024-12-19 17:32:55
success boolean Request success flag true false true
  • id string
    Unique Refund ID
    Example: 5QWlqB2kKJ
  • status string
    Refund Status
    Possible values: NEW PROCESS SUCCESS FAIL
    Example: NEW
  • amount decimal
    Refund Amount
    Example: 1355.91
  • currency enum
    Currency
    Possible values: USD RUB EUR
    Example: RUB
  • entity_type string
    Refund Type
    Possible values: payment
    Example: payment
  • entity_id string
    Unique identifier of the payment being refunded
    Example: LXZv3R7Q8B
  • operation_id string
    Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments
    Example: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Date and time the refund was created
    Example: 2024-12-19 17:32:55
  • success boolean
    Request success flag
    Possible values: true false
    Example: true

Request example

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

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
400 api:error.balance_not_enough Insufficient balance for payout
400 api:error.refund_tariff_not_found Refund tariff is not configured for shop
401 Unauthenticated Invalid API Token
403 api:error.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_banned Merchant is banned
403 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 Type Description Possible values Example
id required string Unique Refund ID LXZv3R7Q8B
  • id string required
    Unique Refund ID
    Example: LXZv3R7Q8B

Response parameters

Parameter name Type Description Possible values Example
id string Unique Refund ID 5QWlqB2kKJ
status string Refund Status NEW PROCESS SUCCESS FAIL NEW
amount decimal Refund Amount 1355.91
currency enum Currency USD RUB EUR RUB
entity_type string Refund Type payment payment
entity_id string Unique identifier of the payment being refunded LXZv3R7Q8B
operation_id string Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments zeAmwP2d5Q
created_at datetime Y-m-d H:i:s Date and time the refund was created 2024-12-19 17:32:55
success boolean Request success flag true false true
  • id string
    Unique Refund ID
    Example: 5QWlqB2kKJ
  • status string
    Refund Status
    Possible values: NEW PROCESS SUCCESS FAIL
    Example: NEW
  • amount decimal
    Refund Amount
    Example: 1355.91
  • currency enum
    Currency
    Possible values: USD RUB EUR
    Example: RUB
  • entity_type string
    Refund Type
    Possible values: payment
    Example: payment
  • entity_id string
    Unique identifier of the payment being refunded
    Example: LXZv3R7Q8B
  • operation_id string
    Identifier of the capture operation the refund is made from. Returned only for refunds of two-stage payments
    Example: zeAmwP2d5Q
  • created_at datetime, Y-m-d H:i:s
    Date and time the refund was created
    Example: 2024-12-19 17:32:55
  • success boolean
    Request success flag
    Possible values: true false
    Example: true

Request example

curl -X GET 'https://cardlink.link/api/v1/refund/status?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.ip_access_denied Request IP is not in whitelist
403 api:error.merchant_banned Merchant is banned
403 api:error.merchant_not_found Merchant not found
422 Input data validation error
500 api:error.general_error Internal error

Postback

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 Type Description Possible values Example
InvId required string order_id field passed when creating the bill payment-19238465
OutSum required decimal Payment amount 380.55
Commission required decimal Payment commission 30.55
TrsId required string Unique Bill identifier LXZv3R7Q8B
Status required enum Payment status SUCCESS UNDERPAID OVERPAID FAIL SUCCESS
CurrencyIn required enum The currency in which the bill was paid USD RUB EUR RUB
custom string Custom field, passed when creating a bill additional_information
AccountType enum Payment method BANK_CARD SBP BANK_CARD
AccountNumber string Additional information about the payment method 220220******7046
BalanceAmount decimal The amount that has been credited to the balance 350.00
BalanceCurrency enum The currency in which was credited funds to the balance USD RUB EUR RUB
PayerPhone string Payer phone 79112223344
PayerEmail string Payer email payer@example.com
PayerName string Payer name Ivan
PayerComment string Payer comment Payment comment
ErrorCode integer Error code 666
ErrorMessage string Description errors General error
SignatureValue required string Request signature. It is formed as follows: strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • InvId string required
    order_id field passed when creating the bill
    Example: payment-19238465
  • OutSum decimal required
    Payment amount
    Example: 380.55
  • Commission decimal required
    Payment commission
    Example: 30.55
  • TrsId string required
    Unique Bill identifier
    Example: LXZv3R7Q8B
  • Status enum required
    Payment status
    Possible values: SUCCESS UNDERPAID OVERPAID FAIL
    Example: SUCCESS
  • CurrencyIn enum required
    The currency in which the bill was paid
    Possible values: USD RUB EUR
    Example: RUB
  • custom string
    Custom field, passed when creating a bill
    Example: additional_information
  • AccountType enum
    Payment method
    Possible values: BANK_CARD SBP
    Example: BANK_CARD
  • AccountNumber string
    Additional information about the payment method
    Example: 220220******7046
  • BalanceAmount decimal
    The amount that has been credited to the balance
    Example: 350.00
  • BalanceCurrency enum
    The currency in which was credited funds to the balance
    Possible values: USD RUB EUR
    Example: RUB
  • PayerPhone string
    Payer phone
    Example: 79112223344
  • PayerEmail string
    Payer email
    Example: payer@example.com
  • PayerName string
    Payer name
    Example: Ivan
  • PayerComment string
    Payer comment
    Example: Payment comment
  • ErrorCode integer
    Error code
    Example: 666
  • ErrorMessage string
    Description errors
    Example: General error
  • SignatureValue string required
    Request signature. It is formed as follows: strtoupper(md5($OutSum . ":" . $InvId . ":" . $apiToken))
    Example: DC32D403CE6BD2E54D4D213278DB286C

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 Type Description Possible values Example
TrsId required string Unique payout identifier LXZv3R7Q8B
InvId string order_id field passed when creating the payout. May be null if it was not provided payout-19238465
Amount required decimal Payout amount with commission 3150.00
IsAuto required boolean Automatic payout flag true false false
Status required enum Payout status SUCCESS DECLINED FAIL SUCCESS
Currency required enum Currency in which the payout is made USD RUB EUR USDT RUB
Commission required decimal System commission in the payout currency 150.00
AccountType enum Account type to which funds are sent BANK_CARD SBP CRYPTO BANK_CARD
AccountNumber string Account identifier depending on AccountType:
BANK_CARD - full card number
SBP - full phone number
CRYPTO - network and full wallet address as network:address
2202201234567046
BalanceAmount decimal Amount debited from the balance 3150.00
BalanceCommission decimal System commission, in the balance currency 150.00
BalanceCurrency enum Balance currency USD RUB EUR RUB
CommissionApplyType enum Who paid the commission sender recipient sender
SignatureValue required string Request signature. Formed as follows: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • TrsId string required
    Unique payout identifier
    Example: LXZv3R7Q8B
  • InvId string
    order_id field passed when creating the payout. May be null if it was not provided
    Example: payout-19238465
  • Amount decimal required
    Payout amount with commission
    Example: 3150.00
  • IsAuto boolean required
    Automatic payout flag
    Possible values: true false
    Example: false
  • Status enum required
    Payout status
    Possible values: SUCCESS DECLINED FAIL
    Example: SUCCESS
  • Currency enum required
    Currency in which the payout is made
    Possible values: USD RUB EUR USDT
    Example: RUB
  • Commission decimal required
    System commission in the payout currency
    Example: 150.00
  • AccountType enum
    Account type to which funds are sent
    Possible values: BANK_CARD SBP CRYPTO
    Example: BANK_CARD
  • AccountNumber string
    Account identifier depending on AccountType:
    BANK_CARD - full card number
    SBP - full phone number
    CRYPTO - network and full wallet address as network:address
    Example: 2202201234567046
  • BalanceAmount decimal
    Amount debited from the balance
    Example: 3150.00
  • BalanceCommission decimal
    System commission, in the balance currency
    Example: 150.00
  • BalanceCurrency enum
    Balance currency
    Possible values: USD RUB EUR
    Example: RUB
  • CommissionApplyType enum
    Who paid the commission
    Possible values: sender recipient
    Example: sender
  • SignatureValue string required
    Request signature. Formed as follows: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))
    Example: DC32D403CE6BD2E54D4D213278DB286C

Request example

curl -X POST 'https://cardlink.link/callback/payout/success' \
-d 'TrsId=ZqmawDQ9B7l' \
-d 'InvId=payout-19238465' \
-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 Type Description Possible values Example
Id required string Unique refund identifier LXZv3R7Q8B
Amount required decimal Refund amount 3150.00
Currency required enum The currency in which the refund is made USD RUB EUR USDT RUB
Status required enum Refund status SUCCESS FAIL SUCCESS
InvId required string Unique order identifier passed when generating the invoice for which the refund is being performed payment-19238465
BillId required string Unique bill identifier KSvv3R7123
PaymentId required string Unique payment identifier for which a refund occurred QSvv3R7123
SignatureValue required string Request signature. Formed as follows: strtoupper(md5($Amount . ":" . $Currency . ":" . $BillId . ":" . $PaymentId . ":". $Id . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • Id string required
    Unique refund identifier
    Example: LXZv3R7Q8B
  • Amount decimal required
    Refund amount
    Example: 3150.00
  • Currency enum required
    The currency in which the refund is made
    Possible values: USD RUB EUR USDT
    Example: RUB
  • Status enum required
    Refund status
    Possible values: SUCCESS FAIL
    Example: SUCCESS
  • InvId string required
    Unique order identifier passed when generating the invoice for which the refund is being performed
    Example: payment-19238465
  • BillId string required
    Unique bill identifier
    Example: KSvv3R7123
  • PaymentId string required
    Unique payment identifier for which a refund occurred
    Example: QSvv3R7123
  • SignatureValue string required
    Request signature. Formed as follows: strtoupper(md5($Amount . ":" . $Currency . ":" . $BillId . ":" . $PaymentId . ":". $Id . ":" . $apiToken))
    Example: DC32D403CE6BD2E54D4D213278DB286C

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 Type Description Possible values Example
Id required string Unique chargeback identifier LXZv3R7Q8B
Status required enum Chargeback status SUCCESS FAIL SUCCESS
InvId required string Unique order identifier passed when generating the invoice for which the chargeback is being performed payment-19238465
BillId required string Unique bill identifier KSvv3R7123
PaymentId required string Unique payment identifier for which a chargeback occurred QSvv3R7123
SignatureValue required string Request signature. Formed as follows: strtoupper(md5($BillId . ":". $PaymentId . ":". $Id . ":" . $apiToken)) DC32D403CE6BD2E54D4D213278DB286C
  • Id string required
    Unique chargeback identifier
    Example: LXZv3R7Q8B
  • Status enum required
    Chargeback status
    Possible values: SUCCESS FAIL
    Example: SUCCESS
  • InvId string required
    Unique order identifier passed when generating the invoice for which the chargeback is being performed
    Example: payment-19238465
  • BillId string required
    Unique bill identifier
    Example: KSvv3R7123
  • PaymentId string required
    Unique payment identifier for which a chargeback occurred
    Example: QSvv3R7123
  • SignatureValue string required
    Request signature. Formed as follows: strtoupper(md5($BillId . ":". $PaymentId . ":". $Id . ":" . $apiToken))
    Example: DC32D403CE6BD2E54D4D213278DB286C

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'

As a result of the p2p deal 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 Type Description Possible values Example
TrsId required string Unique P2P Deal identifier LXZv3R7Q8B
InvId required string order_id field passed when creating the p2p deal p2p-19238465
Status required enum P2P Deal status NEW PROCESS SUCCESS FAIL SUCCESS
Amount decimal Deal amount 350.00
Currency enum Deal currency USD RUB EUR RUB
BalanceAmount decimal The amount that has been credited to the balance 350.00
BalanceCurrency enum The currency in which was credited funds to the balance USD RUB EUR RUB
Payment array Payment information []
Payment[TrsId] required string Unique Bill identifier LXZv3R7Q8B
Payment[Status] required enum Payment status SUCCESS UNDERPAID OVERPAID FAIL SUCCESS
Payment[AccountType] enum Payment method BANK_CARD SBP BANK_CARD
Payment[AccountNumber] string Additional information about the payment method 220220******7046
Payment[AccountBank] string Bank of the payment method BoA
Payment[OutSum] decimal Payment amount 380.55
Payment[Commission] decimal Payment commission 30.55
Payment[CommissionApplyType] enum Who paid the commission payer recipient payer
Payment[CurrencyIn] required enum The currency in which the bill was paid USD RUB EUR RUB
Payment[ErrorCode] integer Error code 666
Payment[ErrorMessage] string Description errors General error
Payout array Payout information []
Payout[TrsId] required string Unique payout identifier LXZv3R7Q8B
Payout[Status] required enum Payout status SUCCESS DECLINED FAIL SUCCESS
Payout[AccountType] enum Account type to which funds are sent BANK_CARD SBP CRYPTO STEAM BANK_CARD
Payout[AccountNumber] string Account identifier depending on AccountType:
BANK_CARD - card number
SBP - phone number
220220******7046
Payout[Amount] required decimal Payout amount with commission 3150.00
Payout[Commission] required decimal System commission in the payout currency 150.00
Payout[CommissionApplyType] required enum Who paid the commission sender recipient sender
Payout[Currency] required enum Currency in which the payout is made USD RUB EUR USDT RUB
Payout[ErrorCode] integer Error code 666
Payout[ErrorMessage] string Description errors General error
SignatureValue required string Request signature. Formed as follows: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken)) DC32DD4D2B286C
  • TrsId string required
    Unique P2P Deal identifier
    Example: LXZv3R7Q8B
  • InvId string required
    order_id field passed when creating the p2p deal
    Example: p2p-19238465
  • Status enum required
    P2P Deal status
    Possible values: NEW PROCESS SUCCESS FAIL
    Example: SUCCESS
  • Amount decimal
    Deal amount
    Example: 350.00
  • Currency enum
    Deal currency
    Possible values: USD RUB EUR
    Example: RUB
  • BalanceAmount decimal
    The amount that has been credited to the balance
    Example: 350.00
  • BalanceCurrency enum
    The currency in which was credited funds to the balance
    Possible values: USD RUB EUR
    Example: RUB
  • Payment array
    Payment information
    Example: []
  • Payment[TrsId] string required
    Unique Bill identifier
    Example: LXZv3R7Q8B
  • Payment[Status] enum required
    Payment status
    Possible values: SUCCESS UNDERPAID OVERPAID FAIL
    Example: SUCCESS
  • Payment[AccountType] enum
    Payment method
    Possible values: BANK_CARD SBP
    Example: BANK_CARD
  • Payment[AccountNumber] string
    Additional information about the payment method
    Example: 220220******7046
  • Payment[AccountBank] string
    Bank of the payment method
    Example: BoA
  • Payment[OutSum] decimal
    Payment amount
    Example: 380.55
  • Payment[Commission] decimal
    Payment commission
    Example: 30.55
  • Payment[CommissionApplyType] enum
    Who paid the commission
    Possible values: payer recipient
    Example: payer
  • Payment[CurrencyIn] enum required
    The currency in which the bill was paid
    Possible values: USD RUB EUR
    Example: RUB
  • Payment[ErrorCode] integer
    Error code
    Example: 666
  • Payment[ErrorMessage] string
    Description errors
    Example: General error
  • Payout array
    Payout information
    Example: []
  • Payout[TrsId] string required
    Unique payout identifier
    Example: LXZv3R7Q8B
  • Payout[Status] enum required
    Payout status
    Possible values: SUCCESS DECLINED FAIL
    Example: SUCCESS
  • Payout[AccountType] enum
    Account type to which funds are sent
    Possible values: BANK_CARD SBP CRYPTO STEAM
    Example: BANK_CARD
  • Payout[AccountNumber] string
    Account identifier depending on AccountType:
    BANK_CARD - card number
    SBP - phone number
    Example: 220220******7046
  • Payout[Amount] decimal required
    Payout amount with commission
    Example: 3150.00
  • Payout[Commission] decimal required
    System commission in the payout currency
    Example: 150.00
  • Payout[CommissionApplyType] enum required
    Who paid the commission
    Possible values: sender recipient
    Example: sender
  • Payout[Currency] enum required
    Currency in which the payout is made
    Possible values: USD RUB EUR USDT
    Example: RUB
  • Payout[ErrorCode] integer
    Error code
    Example: 666
  • Payout[ErrorMessage] string
    Description errors
    Example: General error
  • SignatureValue string required
    Request signature. Formed as follows: strtoupper(md5($Amount . ":" . $TrsId . ":" . $apiToken))
    Example: DC32DD4D2B286C

Request example

curl -X POST 'https://cardlink.link/callback/p2p-deal/success' \
-H 'Authorization: Bearer 72|oBCB7Z3SmUm1gvkpEdRcSR2q1ERHpG4vD3DNBmuT' \
-d 'TrsId=AbxvAM6vJk' \
-d 'InvId=123' \
-d 'Status=SUCCESS' \
-d 'Amount=123' \
-d 'Currency=RUB' \
-d 'BalanceAmount=123' \
-d 'BalanceCurrency=RUB' \
-d 'Payment=' \
-d 'Payout=' \
-d 'SignatureValue=398320589F8E31ACE27CC681BCBD8BDA'

Additional

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

This action is irreversible