1. Appian - Submerchant Register
  • API Docs Mexico 🇲🇽
  • Online Payments
    • Release Notes
    • Card Payments
      • Request a card token
      • Make a charge or deferred charge
      • Create payment (tokenless)
      • Request deferred options
      • Refund a transaction
      • Authorize payments
      • Preauthorization (tokenless)
      • Void a transaction
      • Reauthorize payments
      • Capture an authorized payment
      • Bin Info V2
      • Bin Info
      • Validate OTP
      • Verify Account
    • One-Click and 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
    • 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
    • Smartlinks
      • Create a Smartlink
      • Get a Smartlink
      • Delete a smartlink
      • Update a Smartlink
    • Payment Button
      • Create a payment button
    • Analytics
      • Get transactions list v1
      • Get transactions list v2
    • Chargebacks
      • Query chargebacks
      • Request chargeback export
    • Commissions
      • Get Commission Configuration
    • Payment Credentials
      • Create a credential
      • Activate or deactivate
      • Delete credential
      • Regenerate a credential
      • Update credential
      • Advanced search
      • Search credentials
    • Platform Status
      • Get platform status
      • Get gateway status
    • Settlement
      • Query settlement
    • Subscription Transactions
      • Get subscription transactions
  • Card Present Billpocket
    • Get Started
      • Create Account
      • User Token
      • API Keys
    • Webhooks
      • Webhooks — Transfer Funds (v1)
      • Webhooks — Transfer Funds to Your Bank Account
      • Transfer Funds Errors
    • Terminals
      • App Review
      • Splash Screen
    • Card Present Payment Services
      • Cloud Terminal API
        • Collect card payments
        • Print Ticket
        • Cancel Push Notification
        • Get transaction status
        • Collect card payments v2
      • App-to-App
        • Android intents
        • App to App — iOS
        • App to App — Mobile Web
      • Terminal SDK
        • Terminal SDK
        • Android SDK errors
    • Card not Present Billpocket Services
      • 3DS Checkout
        • Create checkout
        • Get checkout details
      • E-commerce Flex
        • Get token
        • Validate token
        • Collect payments
        • Refund
        • Capture an authorized payment
        • Get status
    • Catalogs
      • States
      • Municipalities
      • Tax companies
      • Commercial activities
    • User Settings
      • Create user
    • Accounts
      • Clabe Account Setup
        • Add CLABE account
      • Deposit Accounts
        • Add or update CLABE account
    • Transactions
      • Transaction List
        • Get token
        • Get transaction list
        • Get transaction list v2
        • Get transaction list v3
        • Get transaction list v4
      • Cancel Payments
        • Cancel payments Error Codes
        • Cancel payments
  • API Raw Card Present
    • The Amount Object
    • Error Catalog
    • Key Exchange Process
    • Release Notes
    • Test Data
    • One-time payments
      • Single payment
    • Two-step-payments
      • Authorization and capture
    • Voids & Refunds
      • Refund a transaction
    • Card information
      • Get BIN Info
      • Balance inquiries
      • Bin Info V2
      • Request deferred options
    • Query Transactions
      • Transaction Search
    • Webhooks
      • Webhooks — Introduction
      • Good Practices
      • Webhooks — Card Payments
      • Webhooks — Refunds
      • Check Your Webhooks
  • Kushki One
    • Cloud Services
      • Payment
        • Charge
        • Authorization (Pre-auth)
        • Capture
        • Re-authorization
        • Post-tip
        • Void
        • Refund
        • Abort
      • Search
        • Transaction Search
      • Print
        • Create Print Job
        • Get Print Job Status
    • Local Services
      • Print
        • Create Print Job
        • Get Print Job Status
        • Print Job Webhook (inbound — implemented by your POS)
      • Payment
        • Charge
        • Authorization (Pre-auth)
        • Capture
        • Re-authorization
        • Post-tip
        • Void
        • Refund
        • Abort
      • Search
        • Transaction Search — Online
        • Transaction Search — Local
  • Appian - Submerchant Register
    • Submerchant Validation in Batch
      POST
    • Query submerchant status by requestId/submerchantId
      GET
    • Submerchant Document Upload
      POST
    • Get submerchantIds
      GET
    • Get credentials for submerchants
      POST
  • Schemas
    • RequestBodies
      • one-and-two-step-payment
    • Card
    • Channel
    • Amount-cash-in
    • ChargebackListResponse
    • StatusComponent
    • SettlementDateRangeRequest
    • SubscriptionTransactionsResponse
    • amount
    • AmountWithTaxes
    • PrintJobRequest
    • networkToken
    • ChargebackItem
    • SettlementTicketRequest
    • SubscriptionTransaction
    • extra_taxes
    • AmountCore
    • CommandText
    • currency
    • ErrorResponse400
    • ErrorResponse
    • SettlementResponse
    • webhooksItem
    • card
    • ExtraTaxes
    • CommandColumns
    • Amount
    • Country
    • ErrorResponse401
    • SettlementRecord
    • card_details
    • ColumnItem
    • extraTaxes
    • ErrorResponse403
    • enc_tlv
    • TransactionResponse
    • CommandDivider
    • Deferred
    • payment_method
    • ErrorResponse500
    • deferred
    • RawResponse
    • CommandFeed
    • Metadata
    • pos_details
    • CardData
    • CommandSpace
    • ContactDetails
    • contact_details
    • sub_merchant
    • AmountWithTip
    • CommandCut
    • documentType
    • Subscription
    • metadata
    • LinkFailure
    • CommandImage
    • orderDetails
    • Language
    • TransactionSearchRequest
    • CommandQR
    • Shipping Address
    • payment_submethod
    • CommandBarcode
    • Billing-Address
    • SubscriptionUpdate
    • PrinterError
    • product
    • SubscriptionAdjustmentRequest
    • PrintJobStatus
    • threeDomainSecure
    • 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. 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.
Status Detail Enhancement (MX Only)
Only for submerchants with the Operation Country: Mexico (MX)
When a submerchant is in the PSP Pending Information status, the response is enhanced to include the pendingDocuments array, giving the PSP visibility into which documents are required to complete the task.

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. Important: For Mexico (MX) submerchants, this status will include the pendingDocuments array in the response to detail which specific documents are pending submission or review.
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:34:20
Previous
Submerchant Validation in Batch
Next
Submerchant Document Upload
Built with