1. Online Payments
  • Developer Docs Ecuador 🇪🇨
  • Online Payments
    • Release Notes
    • Card Payments
      • Request a card token
      • Make a charge or deferred charge
      • Refund a transaction
      • Void a transaction
      • Request deferred options
      • Validate OTP
      • Bin Info V2
      • Bin Info
    • One Click and Scheduled Payments
      • Request a recurring charge token
      • Create a recurring charge
      • Update recurring charge card data
      • Make an One-click payment
      • Cancel a recurring charge
      • Update a recurring charge
      • Add a temporary charge or discount
      • Get recurring charge Info
    • Chargebacks
      • Query chargebacks
      • Request chargeback export
    • Subscription Transactions
      • Get subscription transactions
    • Transfer in
      • Request a Transfer In token
      • Init Transaction
      • Get Status
    • Cash in
      • Request a cash in token
      • Init Transaction
      • Update a cash in transaction
      • Transaction Status
      • Delete a cash in transaction
    • Smartlinks
      • Create a Smartlink
      • Update a Smartlink
      • Get a Smartlink
      • Delete a smartlink
    • Analytics
      • Get transactions list v1
      • Get transactions list v2
    • Status
      • Get gateway status
      • Get platform status
    • Commissions
      • Get Commission Configuration
    • Payment Credentials
      • Create a credential
      • Search credentials
      • Activate or deactivate
      • Delete credential
      • Update credential
      • Regenerate a credential
      • Advanced search
    • Payment Button
      • Create a payment button
    • Settlement
      • Query settlement
  • Appian - Submerchant Register
    • Submerchant Validation in Batch
    • Query submerchant status by requestId/submerchantId
    • Get submerchantIds
    • Get credentials for submerchants
  • Schemas
    • threeDomainSecure
    • webhooks
    • Card-old
    • Channel
    • Amount-cash-in
    • ChargebackListResponse
    • StatusComponent
    • SettlementDateRangeRequest
    • SubscriptionTransactionsResponse
    • Card
    • currency
    • networkToken
    • ChargebackItem
    • ErrorResponse
    • SettlementTicketRequest
    • SubscriptionTransaction
    • Subscription
    • Amount
    • ErrorResponse400
    • SettlementResponse
    • extraTaxes
    • Country
    • ErrorResponse401
    • SettlementRecord
    • Language
    • Deferred
    • ErrorResponse403
    • Metadata
    • payment_method
    • ErrorResponse500
    • ContactDetails
    • documentType
    • orderDetails
    • Shipping Address
    • Billing-Address
    • payment_submethod
    • SubscriptionUpdate
    • product
    • SubscriptionAdjustmentRequest
    • threeDomainSecure
    • webhooks
    • headers
    • webhooksChargeback
    • citMit
    • network
    • binInfo
    • messageFields
    • UnexpectedErrorResponse
    • ExternalReferenceId
    • transactionType
BienvenidaPerú 🇵🇪México 🇲🇽Ecuador 🇪🇨
Colombia 🇨🇴Chile 🇨🇱
BienvenidaPerú 🇵🇪México 🇲🇽Ecuador 🇪🇨
Colombia 🇨🇴Chile 🇨🇱
  1. Online Payments

Gateway Status

Two lightweight endpoints to check the health of both your merchant configuration and the Kushki platform in real time.
Gateway Status
Returns which payment methods (card, transfer, cash) are currently enabled for your merchant account.
Platform Status
Returns the real-time operational status of all Kushki and BillPocket components, with uptime metrics.

Gateway Status#

GET /rules/v1/gatewayStatus
Use this endpoint to verify which payment methods are active for a specific merchant before rendering your checkout. The response returns one boolean per method.

Authentication#

Requires your Public Merchant ID as a header:

Response#

{
  "card": true,
  "transfer": true,
  "cash": false
}
FieldTypeDescription
cardbooleanWhether card payments are enabled for this merchant
transferbooleanWhether bank transfer payments are enabled
cashbooleanWhether cash payments are enabled
Use this endpoint during checkout initialization to conditionally display only the payment methods available to your merchant — no query parameters required.

Platform Status#

GET /data/status
Use this endpoint to monitor the real-time operational health of Kushki and BillPocket. Returns one array per platform, where each item represents a component and its current status.

Authentication#

This endpoint is public and does not require authentication. No request body or query parameters are needed.

Status Values#

StatusDescription
operationalFunctioning normally — no known issues
degraded_performanceReduced performance but still functional
partial_outageSome functionality unavailable for a subset of users
major_outageComponent completely unavailable or severely impacted

Response Structure#

The response contains two arrays — one per platform:
FieldDescription
kushki[]Kushki platform components and their status
billpocket[]BillPocket platform components and their status
Each component object includes:
FieldTypeDescription
namestringDisplay name of the component
statusstringCurrent status (see values above)
descriptionstring | nullIncident description, if any
uptime_percentagenumberUptime % for the reporting period (0–100)
major_outagenumberMajor outage incidents in the reporting period
partial_outagenumberPartial outage incidents in the reporting period
range_startdateStart of the reporting period (YYYY-MM-DD)
range_enddateEnd of the reporting period (YYYY-MM-DD)
updated_atdatetimeLast update to this component's record (ISO 8601)
only_show_if_degradedbooleantrue if this component only appears when there's an active incident

Using the API#

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

Available Endpoints#

Get Gateway Status
Returns active payment methods for a merchant. Requires Public Merchant ID.
Get Platform Status
Returns real-time status for all Kushki and BillPocket components. No authentication required.

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