1. Online Payments
  • API Docs Colombia 🇨🇴
  • Online Payments
    • Release Notes
    • Card Payments
      • Request a card token
      • Make a charge or deferred charge
      • Create payment (tokenless)
      • Void a transaction
      • Refund a transaction
      • Request deferred options
      • Authorize payments
      • Preauthorization (tokenless)
      • Reauthorize payments
      • Capture an authorized payment
      • Verify Account
      • Validate OTP
      • Bin Info
      • BIN info V2
    • One-Click & 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
    • Chargebacks
      • Query chargebacks
      • Request chargeback export
    • 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
    • CASH-IN
      • Request a cash in token
      • Init Transaction
      • Transaction Status
      • Delete a cash in transaction
      • Update a cash in transaction
    • Cash-out
      • Request a cash out token
      • Init Transaction
      • Transaction Status
      • Update a cash out transaction
      • Delete a cash out transaction
    • Smartlinks-v2
      • Create a Smartlink
      • Get a Smartlink
      • Update a Smartlink
      • Delete a smartlink
    • Analytics
      • Get transactions list v1
      • Get transactions list v2
    • Gateway-status
      • Get gateway status
      • Get platform status
    • Payment Credentials
      • Create a credential
      • Search credentials
      • Advanced search
      • Delete credential
      • Regenerate a credential
      • Activate or deactivate
      • Update credential
    • Payment Button
      • Create a payment button
    • Settlement
      • Query settlement
    • Subscription Transactions
      • Get subscription transactions
  • Kushki One
    • Cloud Services
      • Payment
        • Charge
        • Authorization (Pre-auth)
        • Capture
        • Re-authorization
        • Post-tip
        • Void
        • Refund
        • Abort
        • Transaction Search
      • Print
        • Create Print Job
        • Get Print Job Status
    • Local Services
      • Payment
        • Charge
        • Authorization (Pre-auth)
        • Capture
        • Re-authorization
        • Post-tip
        • Void
        • Refund
        • Abort
        • Transaction Search — Online
        • Transaction Search — Local
      • Print
        • Create Print Job
        • Get Print Job Status
        • Print Job Webhook (inbound — implemented by your POS)
  • API RAW CARD PRESENT PAYMENTS
    • Release Notes
    • Error Catalog
    • The Amount Object
    • Key Exchange Process
    • Test data
    • Card Information
      • Get BIN Info
      • Balance inquiries
      • BIN info V2
      • Request deferred options
    • One-time Payments
      • Single payment
    • Two-step Payments
      • Authorization and capture
    • Voids & Refunds
      • Void & Reverse
      • Refund a transaction
    • Query Transactions
      • Transaction Search
    • Webhooks
      • Introduction
      • Good Practices
      • Webhooks-Card Payments
      • Webhooks-Refunds
      • Check your webhooks
  • Appian - Submerchant Register
    • Submerchant Validation in Batch
    • Query submerchant status by requestId/submerchantId
    • Get submerchantIds
    • Get credentials for submerchants
  • Schemas
    • RequestBodies
      • one-and-two-step-payment
    • SubscriptionTransactionsResponse
    • Card
    • Channel
    • Amount-cash-in
    • ChargebackListResponse
    • SettlementDateRangeRequest
    • AmountWithTaxes
    • PrintJobRequest
    • card
    • SubscriptionTransaction
    • networkToken
    • ChargebackItem
    • SettlementTicketRequest
    • AmountCore
    • CommandText
    • amount
    • ErrorResponse
    • currency
    • webhooksItem
    • ErrorResponse400
    • SettlementResponse
    • ExtraTaxes
    • CommandColumns
    • extra_taxes
    • Amount
    • ErrorResponse401
    • SettlementRecord
    • ColumnItem
    • pos_details
    • extraTaxes
    • ErrorResponse403
    • TransactionResponse
    • CommandDivider
    • card_details
    • Deferred
    • Country
    • payment_method
    • ErrorResponse500
    • RawResponse
    • CommandFeed
    • enc_tlv
    • Metadata
    • CardData
    • CommandSpace
    • contact_details
    • ContactDetails
    • AmountWithTip
    • CommandCut
    • deferred
    • sub_merchant
    • documentType
    • Subscription
    • LinkFailure
    • CommandImage
    • metadata
    • orderDetails
    • Language
    • TransactionSearchRequest
    • CommandQR
    • Shipping Address
    • payment_submethod
    • CommandBarcode
    • Billing-Address
    • PrinterError
    • product
    • SubscriptionUpdate
    • PrintJobStatus
    • threeDomainSecure
    • SubscriptionAdjustmentRequest
    • 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. Online Payments

PAYMENT-CREDENTIALS

Payment Credentials lets you programmatically manage the API key pairs associated with your merchant account. You can create additional credentials for different integrations or locations, search existing ones, activate or deactivate them, update their metadata, and regenerate their keys if they are compromised.
Master credential required
All endpoints in this section require a master credential (Credential Master user). This role is available on demand — contact your Kushki account manager to enable it.

Credential Types#

TypeDescription
masterRoot credential of the merchant. Used to manage other credentials.
slaveSub-credentials scoped to a specific integration, location, or use case.
Each credential has a public_credential_id (Public Key) and a private_credential_id (Private Key) used for API authentication.

Available Operations#

Create a Credential
Creates a new credential under your merchant account and returns a fresh public/private key pair.
Request fields:
FieldRequiredDescription
merchant_id✅Your merchant ID
aliasHuman-readable label for the credential (e.g. "Tienda Bogotá")
enableWhether the credential is active on creation. Defaults to true.
hiddenHide the credential from the Console UI
metadataCustom key-value object for internal tracking
Response fields:
FieldDescription
credential_idUnique internal ID for this credential
public_credential_idPublic Key — use as Public-Merchant-Id in API requests
private_credential_idPrivate Key — use as Private-Merchant-Id in API requests
aliasLabel assigned to the credential
metadataMetadata attached at creation
Search Credentials
Returns a paginated list of credentials associated with your merchant, with optional filters.
Request fields:
FieldRequiredDescription
limit✅Max number of credentials to return
merchantIdFilter by merchant ID
offsetPagination offset
filterFilter object — accepts alias, credentialId, publicCredentialId, privateCredentialId, merchantId
The response returns a data array and a total count.
Advanced Search
Searches credentials by keyword across their fields (alias, IDs). Useful for finding a specific credential quickly.
Request fields:
FieldDescription
searchTermKeyword to search across credential fields
merchantIdRestrict results to a specific merchant ID
Activate or Deactivate
Enables or disables a credential identified by its credentialId (path parameter).
Request body:
FieldRequiredValues
action✅"ACTIVATE" or "DEACTIVATE"
Deactivated credentials immediately stop accepting API requests. Reactivate them at any time with "ACTIVATE".
Update a Credential
Updates the alias or metadata of an existing credential. The credential ID is passed as a path parameter.
Request fields:
FieldRequiredDescription
merchantId✅Your merchant ID
aliasNew human-readable label
metadataUpdated metadata object
Regenerate a Credential
Generates new public and private keys for a credential identified by its public_credential_id (path parameter).
⚠️ The old keys are immediately invalidated. All integrations using the old keys will stop working. The new keys replace the old ones automatically wherever the credential is referenced in Kushki's system.
Use this endpoint if a credential is compromised or you want to rotate keys as a security measure.
Delete a Credential
Permanently deletes a credential. The credentialId is passed as a path parameter.
⚠️ Deletion is irreversible. Any integration using the deleted credential will immediately stop working.

Authentication#

All endpoints use your master credential private key:
Never expose your Private-Merchant-Id in client-side or frontend code.

Using the API#

🟢 Production
🧪 Sandbox (UAT)
https://api.kushkipagos.com/

Available Endpoints#

Create a Credential
Creates a new credential and returns a fresh public/private key pair.
Search Credentials
Returns a paginated list of credentials with optional filters.
Advanced Search
Find credentials by keyword across alias and ID fields.
Activate or Deactivate
Enable or disable a credential by its credentialId.
Update a Credential
Update the alias or metadata of an existing credential.
Regenerate a Credential
Issue new public and private keys, invalidating the old ones immediately.
Delete a Credential
Permanently delete a credential.
Got a suggestion on this documentation? Contact us.
Modified at 2026-07-11 00:04:31
Previous
Get platform status
Next
Create a credential
Built with