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

GATEWAY-STATUS

Two status endpoints let you monitor both your merchant configuration and the Kushki platform health in real time.

Get Gateway Status#

Returns which payment methods are currently enabled for your specific merchant account. Use it at checkout load time to dynamically show only the options that are active.
GET /rules/v1/gatewayStatus
Public-Merchant-Id: <your-public-key>
Response fields:
FieldTypeDescription
cardbooleantrue if card payments (credit/debit) are enabled
transferbooleantrue if bank transfer (PSE) is enabled
cashbooleantrue if cash payments are enabled
Example response:
{
  "card": true,
  "transfer": true,
  "cash": false
}
Call this endpoint on checkout load and render only the payment methods that return true. This prevents showing options that are temporarily disabled or not configured for your account.

Get Platform Status#

Returns the operational status of all Kushki and BillPocket platform components — processors, APIs, and infrastructure. No authentication required.
GET /data/status
The response contains two top-level arrays: kushki and billpocket. Each entry is a platform component with its current status, uptime percentage, and incident counters for the reported date range.
Component fields:
FieldTypeDescription
namestringComponent name (e.g. "Payment Processing")
descriptionstringIncident description, if any
statusstringCurrent status — see values below
uptime_percentagenumberUptime % for the reported date range
major_outageintegerNumber of major outages in the period
partial_outageintegerNumber of partial outages in the period
range_start / range_endstringDate range covered by the uptime stats
Possible status values:
ValueMeaning
operationalComponent is fully functional
degraded_performanceComponent is working but with elevated errors or latency
partial_outageComponent is partially unavailable
major_outageComponent is down
Example response:
{
  "kushki": [
    {
      "name": "Payment Processing",
      "description": null,
      "status": "operational",
      "uptime_percentage": 100,
      "major_outage": 0,
      "partial_outage": 0,
      "range_start": "2026-01-01",
      "range_end": "2026-03-31"
    }
  ],
  "billpocket": [
    {
      "name": "Home",
      "description": null,
      "status": "operational",
      "uptime_percentage": 100,
      "major_outage": 0,
      "partial_outage": 0,
      "range_start": "2026-01-01",
      "range_end": "2026-03-31"
    }
  ]
}
This endpoint is publicly accessible — no Merchant-Id header is needed. Use it to build internal dashboards or trigger alerts when a component's status is not "operational".

Authentication#

EndpointAuthentication
Get Gateway StatusPublic-Merchant-Id header required
Get Platform StatusNo authentication required — publicly accessible

Using the API#

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

Available Endpoints#

Get Gateway Status
Returns a boolean per payment method — card, transfer, and cash — indicating whether each is currently active for your merchant.
Get Platform Status
Returns the operational status, uptime, and incident counters for all Kushki and BillPocket platform components. No authentication required.

Got a suggestion on this documentation? Contact us.
Modified at 2026-07-11 00:04:33
Previous
Get transactions list v2
Next
Get gateway status
Built with