1. Appian - Submerchant Register
Español
  • English
  • Español
  • Docs para desarrolladores 🇪🇨
  • Online Payments
    • Notas de versión
    • Errores del API de Kushki
    • Card Payments
      • Solicitar un token de tarjeta
      • Hacer un cargo o cargo diferido
      • Reembolsar una transacción
      • Anular una transacción
      • Solicitar opciones de diferido
      • Validar OTP
      • Información de BIN V2
      • Información de BIN
    • One Click and Scheduled Payments
      • Solicitar un token de cargo recurrente
      • Crear un cargo recurrente
      • Actualizar los datos de la tarjeta del cargo recurrente
      • Hacer un pago One-click
      • Cancelar un cargo recurrente
      • Actualizar un cargo recurrente
      • Agregar un cargo o descuento temporal
      • Consultar información del cargo recurrente
    • Chargebacks
      • Consultar chargebacks
      • Solicitar exportación de chargebacks
    • Subscription Transactions
      • Consultar transacciones de suscripción
    • Cash in
      • Solicitar un token de Cash In
      • Iniciar transacción
      • Actualizar una transacción de Cash In
      • Estado de la transacción
      • Eliminar una transacción de Cash In
    • Transfer in
      • Solicitar un token de Transfer In
      • Iniciar transacción
      • Consultar estado
    • Analytics
      • Consultar listado de transacciones v2
    • Smartlinks
      • Crear un Smartlink
      • Actualizar un Smartlink
      • Consultar un Smartlink
      • Eliminar un Smartlink
    • Status
      • Consultar estado del gateway
      • Consultar estado de la plataforma
    • Commissions
      • Consultar configuración de comisiones
    • Payment Credentials
      • Crear una credencial
      • Buscar credenciales
      • Activar o desactivar
      • Eliminar credencial
      • Actualizar credencial
      • Regenerar una credencial
      • Búsqueda avanzada
    • Payment Button
      • Crear un Payment Button
    • Settlement
      • Consultar liquidación
  • Appian - Submerchant Register
    • Release Notes
    • Submerchant Validation in Batch
      POST
    • Query submerchant status by requestId/submerchantId
      GET
    • Get submerchantIds
      GET
    • Get credentials for submerchants
      POST
  • Schemas
    • threeDomainSecure
    • Card-old
    • Channel
    • SubscriptionTransactionsResponse
    • Card Present (CP)
    • Amount-cash-in
    • webhooks
    • ChargebackListResponse
    • StatusComponent
    • SettlementDateRangeRequest
    • Card
    • networkToken
    • ChargebackItem
    • SettlementRecord
    • Card Not Present (CNP)
    • currency
    • ErrorResponse
    • SubscriptionTransaction
    • Subscription
    • Amount
    • ErrorResponse400
    • SettlementResponse
    • Country
    • Deferred
    • extraTaxes
    • ErrorResponse401
    • Language
    • ErrorResponse403
    • Metadata
    • payment_method
    • ErrorResponse500
    • ContactDetails
    • orderDetails
    • Shipping Address
    • Billing-Address
    • payment_submethod
    • SubscriptionUpdate
    • documentType
    • SubscriptionAdjustmentRequest
    • threeDomainSecure
    • webhooks
    • headers
    • webhooksChargeback
    • citMit
    • network
    • binInfo
    • messageFields
    • UnexpectedErrorResponse
    • ExternalReferenceId
    • product
    • transactionType
    • SettlementTicketRequest
HomePerú 🇵🇪México 🇲🇽Ecuador 🇪🇨
Colombia 🇨🇴Chile 🇨🇱
HomePerú 🇵🇪México 🇲🇽Ecuador 🇪🇨
Colombia 🇨🇴Chile 🇨🇱
  1. Appian - Submerchant Register

Query submerchant status by requestId/submerchantId

https://api-uat.kushkipagos.com
https://api-uat.kushkipagos.com
GET
/onboarding/v1/submerchants
Revisa la notificación por webhook para confirmar que el subcomercio llegó al estado READY_FOR_ONBOARDING. Eso indica que el proceso de validación fue exitoso.
Una vez que un subcomercio ha sido aprobado, este servicio permite a los Payment Service Providers (PSPs) consultar el estado de la creación de subcomercios, ya sea de una solicitud masiva o de un subcomercio específico.

Cómo usar este endpoint#

Para consultar el estado de una solicitud masiva, envía el requestId asociado al lote.
Para obtener información de un subcomercio específico, envía el submerchantId correspondiente.

Manejo de la respuesta#

Al consultar por requestId, la respuesta incluye un array de subcomercios, cada uno con su estado de creación.
Al consultar por submerchantId, la respuesta devuelve un único objeto con los detalles de ese subcomercio.

Estados del subcomercio#

Para saber si el subcomercio entró al proceso de onboarding#

Cada subcomercio de la respuesta puede tener uno de los siguientes estados:
READY_FOR_ONBOARDING- El subcomercio pasó la validación y está listo para el proceso de onboarding
ERROR- La creación del subcomercio falló por problemas de validación o de procesamiento. Debes corregir el problema y volver a enviar la solicitud de creación con los ajustes necesarios.

Para seguir el avance del onboarding#

Solo los subcomercios con estado READY_FOR_ONBOARDING continúan el proceso de onboarding y exponen las actualizaciones de estado posteriores.
Cada subcomercio de la respuesta puede tener uno de los siguientes estados:
Rejected – El subcomercio no fue aprobado. El proceso de onboarding terminó sin éxito.
PSP Pending Information – El subcomercio tiene tareas pendientes en el portal del PSP que debes completar para continuar.
Kushki KYC: Ongoing – Kushki está revisando la información del subcomercio. Si se requiere información adicional, el estado cambia a PSP Pending Information; si no, el proceso continúa a la fase de creación de la cuenta.
Kushki Account Creation: Ongoing – La cuenta del subcomercio se está creando en los sistemas de Kushki. No necesitas hacer nada.
Approved with Conditions – Aprobado, pero debe completar tareas específicas de Post-Producción listadas en el portal.
Approved – Totalmente aprobado y listo para operar

Request

Query Params

Header Params

Responses

🟢200OK
application/json
Respuesta exitosa
Bodyapplication/json

🟠403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/onboarding/v1/submerchants?requestId=&submerchantId=' \
--header 'X-Api-Key;'
Response Response Example
200 - Query by submerchantId
{
    "requestId": "5c91b0ee-677f-448e-b2e8-eb13bf2efcab",
    "submerchantId": "c0d99b38-9590-49fc-b348-899affe20726",
    "status": "ERROR",
    "message": "Submerchant onboarding failed due to invalid fields.",
    "errorDetails": {
        "message": "Submerchant Onboarding Request has failed",
        "fields": {
            "ubo": {
                "uboSecondLastName": "",
                "uboFirstLastName": "",
                "disabled": true,
                "uboFirstName": "",
                "uboDateBirth": ""
            },
            "entityType": "",
            "operationCountry": "Operation Country not registered",
            "emails": "",
            "subLegalName": "",
            "subPostalCode": "",
            "legalRepresentative": {
                "legalRepresentativeName": "",
                "legalRepresentativeSecondLastName": "Second Last Name is invalid",
                "legalRepresentativeFirstLastName": "Value have not valid characters",
                "disabled": false,
                "legalRepresentativeDateBirth": "",
                "legalRepresentativeIdNumber": "",
                "legalRepresentativeSameAsUbo": ""
            },
            "submerchantAddress": "",
            "submerchantCity": "",
            "submerchantUrl": "",
            "submerchantTaxId": "",
            "submerchantName": "",
            "submerchantMcc": "",
            "pspCustomerId": "Select a valid operation country",
            "operationType": "Select a valid operation country",
            "submerchantCountryTaxResidency": "",
            "secondConcurrenceNeeded": ""
        }
    }
}
Modified at 2026-09-03 23:43:22
Previous
Submerchant Validation in Batch
Next
Get submerchantIds
Built with