1. Appian - Submerchant Register
Español
  • English
  • Español
  • Docs de API 🇨🇴
  • Online Payments
    • Errores del API de Kushki
    • Errores ISO
    • Notas de versión
    • Card Payments
      • Solicitar un token de tarjeta
      • Hacer un cargo o cargo diferido
      • Crear pago (sin token)
      • Anular una transacción
      • Reembolsar una transacción
      • Solicitar opciones de diferido
      • Autorizar pagos
      • Preautorización (sin token)
      • Reautorizar pagos
      • Capturar un pago autorizado
      • Verificar cuenta
      • Validar OTP
      • Información de BIN
      • Información de BIN V2
    • One-Click & Scheduled Payments
      • Solicitar un token de cargo recurrente
      • Crear un cargo recurrente
      • Hacer un pago One-click
      • Actualizar los datos de la tarjeta del cargo recurrente
      • Cancelar un cargo recurrente
      • Actualizar un cargo recurrente
      • Agregar un cargo o descuento temporal
      • Autorizar pagos
      • Capturar un pago autorizado
      • Consultar información del cargo recurrente
    • Chargebacks
      • Consultar chargebacks
      • Solicitar exportación de chargebacks
    • Transfer in
      • Consultar lista de bancos
      • Solicitar un token de Transfer In
      • Iniciar transacción
      • Consultar estado
      • Cancelar transacción
    • Transfer out
      • Consultar lista de bancos
      • Consultar lista de bancos V2
      • Solicitar un token de Transfer Out
      • Iniciar transacción
      • Consultar estado
      • Saldo para payouts
    • Cash in
      • Solicitar un token de Cash In
      • Iniciar transacción
      • Estado de la transacción
      • Eliminar una transacción de Cash In
      • Actualizar una transacción de Cash In
    • Cash-out
      • Solicitar un token de Cash Out
      • Iniciar transacción
      • Estado de la transacción
      • Actualizar una transacción de Cash Out
      • Eliminar una transacción de Cash Out
    • Smartlinks-v2
      • Crear un Smartlink
      • Consultar un Smartlink
      • Actualizar un Smartlink
      • Eliminar un Smartlink
    • Analytics
      • Consultar listado de transacciones v2
    • Gateway-status
      • Consultar estado del gateway
      • Consultar estado de la plataforma
    • Payment Credentials
      • Crear una credencial
      • Buscar credenciales
      • Búsqueda avanzada
      • Eliminar credencial
      • Regenerar una credencial
      • Activar o desactivar
      • Actualizar credencial
    • Payment Button
      • Crear un Payment Button
    • Settlement
      • Consultar liquidación
    • Subscription Transactions
      • Consultar transacciones de suscripción
    • Fraud Report
      • Consultar alertas de fraude
  • Kushki One
    • Error Catalog
    • Release notes
    • Transaction Examples
    • Webhooks
    • Cloud Services
      • Payment
        • Sync
          • Charge
          • Authorization (Pre-auth)
          • Capture
          • Re-authorization
          • Post-tip
          • Void
          • Refund
          • Abort
        • Async
          • Charge (Async)
          • Authorization — Pre-auth (Async)
          • Capture (Async)
          • Re-authorization (Async)
          • Post-tip (Async)
          • Void (Async)
        • Search
          • Transaction Search
      • Print
        • Create Print Job
        • Get Print Job Status
    • Local Services
      • Payment
        • Sync
          • Charge
          • Authorization (Pre-auth)
          • Capture
          • Re-authorization
          • Post-tip
          • Void
          • Refund
          • Abort
        • Async
          • Charge (Async)
          • Authorization — Pre-auth (Async)
          • Capture (Async)
          • Re-authorization (Async)
          • Post-tip (Async)
          • Void (Async)
          • Abort (Async)
        • Search
          • 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
    • Notas de versión
    • Catálogo de errores
    • El objeto Amount
    • Proceso de intercambio de llaves
    • Datos de prueba
    • One-time Payments
      • Pago único
    • Two-step Payments
      • Autorización y captura
    • Card Information
      • Consultar información de BIN
      • Información de BIN V2
      • Solicitar opciones de diferido
    • Voids & Refunds
      • Anular y reversar
      • Reembolsar una transacción
    • Query Transactions
      • Búsqueda de transacciones
    • Webhooks
      • Introducción
      • Buenas prácticas
      • Webhooks-Pagos con tarjeta
      • Webhooks-Reembolsos
      • Revisa tus webhooks
    • Chargebacks
      • Consultar chargebacks
      • Solicitar exportación de chargebacks
    • Fraud Report
      • Consultar alertas de fraude
  • 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
    • RequestBodies
      • one-and-two-step-payment
    • Card
    • Channel
    • ChargebackListResponse
    • TransactionResponse
    • PrintJobRequest
    • card
    • one-and-two-step-payment-3
    • Card Present (CP)
    • one-and-two-step-payment-3
    • SubscriptionTransactionsResponse
    • Amount-cash-in
    • SettlementDateRangeRequest
    • amount
    • FraudAlertRequest
    • SubscriptionTransaction
    • ChargebackItem
    • SettlementRecord
    • RawResponse
    • CommandText
    • Card Not Present (CNP)
    • networkToken
    • FraudAlertResponse
    • ErrorResponse400
    • CardData
    • CommandColumns
    • extra_taxes
    • FraudAlertRecord
    • ErrorResponse
    • currency
    • Deferred
    • webhooksItem
    • SettlementResponse
    • ErrorResponse401
    • LinkFailure
    • ColumnItem
    • Amount
    • ValidationError
    • pos_details
    • ErrorResponse403
    • CommandDivider
    • enc_tlv
    • TransactionEvent
    • extraTaxes
    • card_details
    • Country
    • payment_method
    • ErrorResponse500
    • CommandFeed
    • TransactionStatus
    • deferred
    • CommandSpace
    • ReadingType
    • contact_details
    • ContactDetails
    • CommandCut
    • sub_merchant
    • FailureReason
    • CommandImage
    • metadata
    • EventTerminal
    • documentType
    • Subscription
    • orderDetails
    • Language
    • TransactionSearchRequest
    • CommandQR
    • EventOperation
    • Shipping Address
    • payment_submethod
    • CommandBarcode
    • EventAmount
    • Billing-Address
    • EventExtraTaxes
    • PrintJobAccepted
    • PrinterError
    • EventMetadata
    • SubscriptionUpdate
    • AmountWithTaxes
    • PrintJobStatus
    • PrintJobStatusRequest
    • threeDomainSecure
    • SubscriptionAdjustmentRequest
    • AmountCore
    • product
    • webhooks
    • headers
    • ExtraTaxes
    • PrintWebhookPayload
    • Metadata
    • webhooksChargeback
    • AmountWithTip
    • citMit
    • TransactionSearchBody
    • TransactionSearchOnlineBody
    • network
    • binInfo
    • AmountWithOptionalTip
    • TransactionSearchLocalBody
    • TransactionEvent_2
    • messageFields
    • UnexpectedErrorResponse
    • FailureReason_2
    • transactionType
    • ExternalReferenceId
    • EventTerminal_2
    • ExternalSubscriptionId
    • EventOperation_2
    • EventAmount_2
    • EventExtraTaxes_2
    • EventMetadata_2
    • SettlementTicketRequest
    • ErrorResponse
    • TransactionEvent_23
    • TransactionStatus4
    • ReadingType5
    • FailureReason_26
    • EventTerminal_27
    • EventOperation_28
    • EventAmount_29
    • EventMetadata_210
    • EventExtraTaxes_211
    • PrintWebhookPayload12
    • TransactionEvent13
    • FailureReason14
    • EventTerminal15
    • EventOperation16
    • EventAmount17
    • EventMetadata18
    • EventExtraTaxes19
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
https://api-uat.kushkipagos.com
https://api-uat.kushkipagos.com
GET
/onboarding/v1/submerchants
Make sure to check the webhook notification to confirm that the submerchant has reached the READY_FOR_ONBOARDING status. This indicates the validation process was successful.
Once a submerchant has been successfully approved, this service allows Payment Service Providers (PSPs) to check the status of submerchant creation, either for a bulk request or for a specific submerchant.

How to Use This Endpoint#

To check the status of a bulk request, you must send the requestId associated with the batch.
To retrieve information about a specific submerchant, you must provide the corresponding submerchantId.

Response Handling#

When querying by requestId, the response includes an array of submerchants, each with their creation status.
When querying by submerchantId, the response returns a single object containing details for that submerchant.

Submerchant Statuses#

To determine if the submerchant entered the onboarding process#

Each submerchant in the response can have one of the following statuses:
READY_FOR_ONBOARDING- The submerchant has passed validation and is ready for the onboarding process
ERROR- The submerchant creation failed due to validation or processing issues. The issue must be corrected and the creation request resubmitted with the appropriate adjustments.

To track the onboarding progress#

Only submerchants with the READY_FOR_ONBOARDING status will continue through the onboarding process and expose subsequent status updates.
Each submerchant in the response can have one of the following statuses:
Rejected – The submerchant was not approved. The onboarding process has ended unsuccessfully.
PSP Pending Information – The submerchant has pending tasks in the PSP portal that must be completed to continue.
Kushki KYC: Ongoing – Kushki is reviewing the submerchant's information. If additional input is required, the status will change to PSP Pending Information; otherwise, the process will continue to the account creation phase.
Kushki Account Creation: Ongoing – The submerchant's account is being created in Kushki's systems. No action needed.
Approved with Conditions – Approved, but must complete specific Post-Production tasks listed in the portal.
Approved – Fully approved and ready to operate

Request

Query Params

Header Params

Responses

🟢200OK
application/json
Successful response
Bodyapplication/json

🟠403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api-uat.kushkipagos.com/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-01 02:05:36
Previous
Submerchant Validation in Batch
Next
Get submerchantIds
Built with