1. Smartlinks
  • API Docs Mexico 🇲🇽
  • Online Payments
    • Release Notes
    • Card Payments
      • Request a card token
      • Make a charge or deferred charge
      • Create payment (tokenless)
      • Request deferred options
      • Refund a transaction
      • Authorize payments
      • Preauthorization (tokenless)
      • Void a transaction
      • Reauthorize payments
      • Capture an authorized payment
      • Bin Info V2
      • Bin Info
      • Validate OTP
      • Verify Account
    • One-Click and Scheduled Payments
      • Request a recurring charge token
      • Create a recurring charge
      • Make an One-click payment
      • Update recurring charge card data
      • Cancel a recurring charge
      • Update a recurring charge
      • Add a temporary charge or discount
      • Authorize payments
      • Capture an authorized payment
      • Get recurring charge Info
    • Transfer in
      • Get Bank List
      • Request a Transfer In token
      • Init Transaction
      • Get Status
    • Transfer Out
      • Get Bank List
      • Get Bank List V2
      • Request a Transfer Out token
      • Init Transaction
      • Get Status
      • Balance for Payouts
    • Smartlinks
      • Create a Smartlink
        POST
      • Get a Smartlink
        GET
      • Delete a smartlink
        DELETE
      • Update a Smartlink
        PATCH
    • Payment Button
      • Create a payment button
    • Analytics
      • Get transactions list v1
      • Get transactions list v2
    • Chargebacks
      • Query chargebacks
      • Request chargeback export
    • Commissions
      • Get Commission Configuration
    • Payment Credentials
      • Create a credential
      • Activate or deactivate
      • Delete credential
      • Regenerate a credential
      • Update credential
      • Advanced search
      • Search credentials
    • Platform Status
      • Get platform status
      • Get gateway status
    • Settlement
      • Query settlement
    • Subscription Transactions
      • Get subscription transactions
  • Card Present Billpocket
    • Get Started
      • Create Account
      • User Token
      • API Keys
    • Webhooks
      • Webhooks — Transfer Funds (v1)
      • Webhooks — Transfer Funds to Your Bank Account
      • Transfer Funds Errors
    • Terminals
      • App Review
      • Splash Screen
    • Card Present Payment Services
      • Cloud Terminal API
        • Collect card payments
        • Print Ticket
        • Cancel Push Notification
        • Get transaction status
        • Collect card payments v2
      • App-to-App
        • Android intents
        • App to App — iOS
        • App to App — Mobile Web
      • Terminal SDK
        • Terminal SDK
        • Android SDK errors
    • Card not Present Billpocket Services
      • 3DS Checkout
        • Create checkout
        • Get checkout details
      • E-commerce Flex
        • Get token
        • Validate token
        • Collect payments
        • Refund
        • Capture an authorized payment
        • Get status
    • Catalogs
      • States
      • Municipalities
      • Tax companies
      • Commercial activities
    • User Settings
      • Create user
    • Accounts
      • Clabe Account Setup
        • Add CLABE account
      • Deposit Accounts
        • Add or update CLABE account
    • Transactions
      • Transaction List
        • Get token
        • Get transaction list
        • Get transaction list v2
        • Get transaction list v3
        • Get transaction list v4
      • Cancel Payments
        • Cancel payments Error Codes
        • Cancel payments
  • API Raw Card Present
    • The Amount Object
    • Error Catalog
    • Key Exchange Process
    • Release Notes
    • Test Data
    • One-time payments
      • Single payment
    • Two-step-payments
      • Authorization and capture
    • Voids & Refunds
      • Refund a transaction
    • Card information
      • Get BIN Info
      • Balance inquiries
      • Bin Info V2
      • Request deferred options
    • Query Transactions
      • Transaction Search
    • Webhooks
      • Webhooks — Introduction
      • Good Practices
      • Webhooks — Card Payments
      • Webhooks — Refunds
      • Check Your Webhooks
  • Kushki One
    • Cloud Services
      • Payment
        • Charge
        • Authorization (Pre-auth)
        • Capture
        • Re-authorization
        • Post-tip
        • Void
        • Refund
        • Abort
      • Search
        • Transaction Search
      • Print
        • Create Print Job
        • Get Print Job Status
    • Local Services
      • Print
        • Create Print Job
        • Get Print Job Status
        • Print Job Webhook (inbound — implemented by your POS)
      • Payment
        • Charge
        • Authorization (Pre-auth)
        • Capture
        • Re-authorization
        • Post-tip
        • Void
        • Refund
        • Abort
      • Search
        • Transaction Search — Online
        • Transaction Search — Local
  • Appian - Submerchant Register
    • Submerchant Validation in Batch
    • Query submerchant status by requestId/submerchantId
    • Submerchant Document Upload
    • Get submerchantIds
    • Get credentials for submerchants
  • Schemas
    • RequestBodies
      • one-and-two-step-payment
    • Card
    • Channel
    • Amount-cash-in
    • ChargebackListResponse
    • StatusComponent
    • SettlementDateRangeRequest
    • SubscriptionTransactionsResponse
    • amount
    • AmountWithTaxes
    • PrintJobRequest
    • networkToken
    • ChargebackItem
    • SettlementTicketRequest
    • SubscriptionTransaction
    • extra_taxes
    • AmountCore
    • CommandText
    • currency
    • ErrorResponse400
    • ErrorResponse
    • SettlementResponse
    • webhooksItem
    • card
    • ExtraTaxes
    • CommandColumns
    • Amount
    • Country
    • ErrorResponse401
    • SettlementRecord
    • card_details
    • ColumnItem
    • extraTaxes
    • ErrorResponse403
    • enc_tlv
    • TransactionResponse
    • CommandDivider
    • Deferred
    • payment_method
    • ErrorResponse500
    • deferred
    • RawResponse
    • CommandFeed
    • Metadata
    • pos_details
    • CardData
    • CommandSpace
    • ContactDetails
    • contact_details
    • sub_merchant
    • AmountWithTip
    • CommandCut
    • documentType
    • Subscription
    • metadata
    • LinkFailure
    • CommandImage
    • orderDetails
    • Language
    • TransactionSearchRequest
    • CommandQR
    • Shipping Address
    • payment_submethod
    • CommandBarcode
    • Billing-Address
    • SubscriptionUpdate
    • PrinterError
    • product
    • SubscriptionAdjustmentRequest
    • PrintJobStatus
    • threeDomainSecure
    • PrintWebhookPayload
    • webhooks
    • headers
    • webhooksChargeback
    • citMit
    • network
    • binInfo
    • messageFields
    • UnexpectedErrorResponse
    • transactionType
    • ExternalReferenceId
    • ExternalSubscriptionId
BienvenidaPerú 🇵🇪México 🇲🇽
Ecuador 🇪🇨Colombia 🇨🇴Chile 🇨🇱
BienvenidaPerú 🇵🇪México 🇲🇽
Ecuador 🇪🇨Colombia 🇨🇴Chile 🇨🇱
  1. Smartlinks

Get a Smartlink

GET
/smartlink/v2/smart-link/{smartlinkId}
Get the Smartlink information that can be used to render the form in a website hosted by Kushki.

Request

Path Params

Header Params

Responses

🟢200
application/json
Bodyapplication/json

🟠400
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api-uat.kushkipagos.com/smartlink/v2/smart-link/' \
--header 'Private-Merchant-Id;'
Response Response Example
200 - Smartlink found
{
    "paymentConfig": {
        "mixedOptions": {
            "numberOfFees": 13,
            "periodicity": "weekly",
            "subscriptionDay": 28
        },
        "paymentMethod": [
            "cash",
            "credit-card",
            "transfer"
        ],
        "amount": {
            "currency": "MXN",
            "subtotalIva0": 0,
            "iva": 211.09,
            "subtotalIva": 1111
        },
        "subscriptionOptions": {
            "periodicity": "weekly",
            "planName": "Subscription-SmartLink",
            "amount": {
                "currency": "MXN",
                "subtotalIva0": 0,
                "iva": 422.18,
                "subtotalIva": 2222
            },
            "terms": "T&C suscripcion",
            "startDate": "2020-03-15"
        },
        "paymentType": "mixed"
    },
    "executionCount": 0,
    "version": "V2",
    "formConfig": [
        {
            "split": true,
            "icon": "bold",
            "name": "nombresyapellidos",
            "disabled": false,
            "label": "Nombres y apellidos",
            "placeholder": "Nombres y apellidos",
            "type": "input",
            "required": false,
            "selected": false
        },
        {
            "split": true,
            "icon": "bold",
            "name": "email",
            "disabled": false,
            "label": "E-mail",
            "placeholder": "E-mail",
            "type": "input",
            "required": false,
            "selected": false
        },
        {
            "split": true,
            "icon": "server",
            "name": "listadeseleccion",
            "options": [
                "Opcion 1",
                "Opcion 2",
                "Opcion 3"
            ],
            "index": 3,
            "disabled": false,
            "label": "Lista de selección",
            "type": "select",
            "required": false,
            "selected": false
        },
        {
            "split": true,
            "icon": "check-circle",
            "name": "seleccionmultiple",
            "options": [
                "Opcion 1",
                "Opcion 2"
            ],
            "index": 3,
            "disabled": false,
            "label": "Selección múltiple",
            "type": "checkbox",
            "required": false,
            "selected": false
        },
        {
            "split": true,
            "icon": "calendar",
            "name": "fecha",
            "index": 4,
            "disabled": false,
            "label": "Fecha",
            "type": "date",
            "required": false,
            "selected": false
        },
        {
            "split": true,
            "icon": "bold",
            "name": "areadetexto",
            "index": 4,
            "disabled": false,
            "label": "Área de texto",
            "placeholder": "Área de texto",
            "type": "area",
            "required": false,
            "selected": false
        }
    ],
    "generalConfig": {
        "productImage": "https://kushki-static.s3.amazonaws.com/smartlinks/product-image.png",
        "showTimer": true,
        "buyButtonText": "pago",
        "description": "<p>Descipción</p>",
        "executionCount": 0,
        "executionLimit": 999,
        "promotionalText": "promocional",
        "brandLogo": "https://kushki-static.s3.amazonaws.com/smartlinks/logo.png",
        "enabled": true,
        "productName": "nombre producto",
        "expirationDate": 1585717199999,
        "termsAndConditions": "tyc smartlink"
    },
    "created": 1585715919666,
    "publicMerchantId": "20000000100338110000",
    "merchantName": "CLINICA OFTALMOLOGICA",
    "styleAndStructure": {
        "primaryColor": "#00E6B2",
        "coverModel": "left",
        "structure": "cover",
        "buttonStyle": "square",
        "secondaryColor": "#023366"
    },
    "id": "4RUvloWDA",
    "merchantId": "20000000100338110000",
    "subscriptionTotalAmount": 2644.18,
    "totalAmount": 1322.09,
    "paymentConfigType": "fixed",
    "source": "console"
}
Modified at 2026-06-02 20:21:13
Previous
Create a Smartlink
Next
Delete a smartlink
Built with