1. Appian - Submerchant Register
  • 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
      POST
    • Query submerchant status by requestId/submerchantId
      GET
    • Get submerchantIds
      GET
    • Get credentials for submerchants
      POST
  • 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. Appian - Submerchant Register

Query submerchant status by requestId/submerchantId

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

🟢200
application/json
Successful response
Bodyapplication/json

🟠403
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-07-31 15:39:10
Previous
Submerchant Validation in Batch
Next
Get submerchantIds
Built with