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

Submerchant Validation in Batch

POST
/onboarding/v1/submerchants/batch
This endpoint allows Payment Service Providers (PSPs) to submit one or more submerchants for initial validation before they can enter to the onboarding process. This step does not create or onboard submerchants yet; It only checks that the data structure and operational context are valid.
This validation helps ensure that submerchant records meet the required format and that the PSP is eligible to the onboarding process.
Only submerchants that pass the validations will proceed to the actual onboarding process. Those that fail must be corrected and resubmitted.

Request Body (JSON)#

The request must include an array of submerchants, each containing relevant details such as country of operation, legal representatives, ultimate beneficial owners (UBOs), emails, and more.

Response Handling#

If the validation was successful the response includes a status field, which can have one of the following values:
INITIALIZED – The request has been received and is being processed.
VALIDATION_FAILED – At least one submerchant in the request contains errors, preventing successful processing.
Once a submerchant is approved and ready for onboarding, each request generates a unique requestId, which can be used to track the status of the creation process.
Additionally, the response provides an array of submerchants, each with:
submerchantId – A unique identifier assigned to the submerchant.
submerchantName – The name of the submerchant.
status – Indicates if the submerchant passed validation:
VALID – The submerchant was successfully validated.
INVALID – The submerchant contains errors and requires correction.
Make sure to check the webhook notification. This will confirm whether the validation process was successful or rejected.

Request

Header Params

Body Params application/json

Examples

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/batch' \
--header 'X-Api-Key;' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "pspCustomerId": "string",
        "operationType": "CP",
        "operationCountry": "ECU",
        "submerchantCountryTaxResidency": "string",
        "submerchantTaxId": "string",
        "submerchantLegalName": "string",
        "submerchantLegalEntityType": "Private",
        "submerchantName": "string",
        "submerchantAddress": "string",
        "submerchantCity": "Quito",
        "submerchantPostalCode": "strin",
        "submerchantUrl": "string",
        "submerchantMcc": "stri",
        "legalRepresentativeName": "string",
        "legalRepresentativeFirstLastName": "string",
        "legalRepresentativeSecondLastName": "string",
        "legalRepresentativeDateBirth": "12/07/1990",
        "legalRepresentativeIdNumber": "string",
        "legalRepresentativeSameAsUbo": true,
        "uboName": "string",
        "uboFirstLastName": "string",
        "uboSecondLastName": "string",
        "uboDateBirth": "string",
        "ubo2Name": "string",
        "ubo2FirstLastName": "string",
        "ubo2SecondLastName": "string",
        "ubo2DateBirth": "string",
        "secondConcurrenceNeeded": true,
        "pspNotificationEmail": "test@kushkipagos.com",
        "openField": "string"
    }
]'
Response Response Example
200 - INITIALIZED (successful response)
{
    "status": "INITIALIZED",
    "requestId": "5c91b0ee-677f-448e-b2e8-eb13bf2efcab",
    "message": "The submerchants are ready to be processed. We will notify you once all have been processed",
    "results": [
        {
            "submerchantId": "5e9a859c-2112-4e8e-b819-2d18bc0f4d29",
            "submerchantName": "Kushki Ecuador",
            "status": "VALID",
            "message": "The format is valid",
            "errors": []
        },
        {
            "submerchantId": "c0d99b38-9590-49fc-b348-899affe20726",
            "submerchantName": "Empresa Quito CIA. LTDA.",
            "status": "VALID",
            "message": "The format is valid",
            "errors": []
        }
    ]
}
Modified at 2026-07-31 15:39:10
Previous
Appian - Submerchant Register
Next
Query submerchant status by requestId/submerchantId
Built with