1. Appian - Submerchant Register
English
  • English
  • Español
  • API Docs Colombia 🇨🇴
  • Online Payments
    • Release Notes
    • Kushki API errors
    • ISO errors
    • Card Payments
      • Request a card token
      • Make a charge or deferred charge
      • Create payment (tokenless)
      • Void a transaction
      • Refund a transaction
      • Request deferred options
      • Authorize payments
      • Preauthorization (tokenless)
      • Reauthorize payments
      • Capture an authorized payment
      • Verify Account
      • Validate OTP
      • Bin Info
      • BIN info V2
    • One-Click & 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
    • Chargebacks
      • Query Chargebacks
      • Request Chargeback Export
    • Transfer in
      • Get Bank List
      • Request a Transfer In token
      • Init Transaction
      • Get Status
      • Cancel Transaction
    • Transfer out
      • Get Bank List
      • Get Bank List V2
      • Request a Transfer Out token
      • Init Transaction
      • Get Status
      • Balance for Payouts
    • Cash in
      • Request a cash in token
      • Init Transaction
      • Transaction Status
      • Delete a cash in transaction
      • Update a cash in transaction
    • Cash-out
      • Request a cash out token
      • Init Transaction
      • Transaction Status
      • Update a cash out transaction
      • Delete a cash out transaction
    • Smartlinks-v2
      • Create a Smartlink
      • Get a Smartlink
      • Update a Smartlink
      • Delete a smartlink
    • Analytics
      • Get transactions list v2
    • Gateway-status
      • Get gateway status
      • Get platform status
    • Payment Credentials
      • Create a credential
      • Search credentials
      • Advanced search
      • Delete credential
      • Regenerate a credential
      • Activate or deactivate
      • Update credential
    • Payment Button
      • Create a payment button
    • Settlement
      • Query settlement
    • Subscription Transactions
      • Get subscription transactions
    • Fraud Report
      • Query fraud alerts
  • Kushki One
    • Release notes
    • Transaction Examples
    • Webhooks
    • Error Catalog
    • Cloud Services
      • Payment
        • Sync
          • Charge
          • Authorization (Pre-auth)
          • Capture
          • Re-authorization
          • Post-tip
          • Void
          • 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
      • Diagnostics
        • Terminal info
        • Connection test
    • Local Services
      • Payment
        • Sync
          • Charge
          • Authorization (Pre-auth)
          • Capture
          • Re-authorization
          • Post-tip
          • Void
          • 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)
      • Diagnostics
        • Terminal info
        • Connection test
  • API Raw Card Present Payments
    • Release Notes
    • Error Catalog
    • The Amount Object
    • Key Exchange Process
    • Test data
    • One-time Payments
      • Single payment
    • Two-step Payments
      • Authorization and capture
    • Card Information
      • Get BIN Info
      • BIN info V2
      • Request deferred options
    • Voids & Refunds
      • Void & Reverse
      • Refund a transaction
    • Query Transactions
      • Transaction Search
    • Webhooks
      • Introduction
      • Good Practices
      • Webhooks-Card Payments
      • Webhooks-Refunds
      • Check your webhooks
    • Chargebacks
      • Query Chargebacks
      • Request Chargeback Export
    • Fraud Report
      • Query fraud alerts
  • 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
    • SubscriptionTransactionsResponse
    • Card
    • Channel
    • Amount-cash-in
    • ChargebackListResponse
    • SettlementDateRangeRequest
    • PrintJobRequest
    • card
    • amount
    • one-and-two-step-payment-3
    • Card Present (CP)
    • one-and-two-step-payment-3
    • FraudAlertRequest
    • TransactionResponse
    • SubscriptionTransaction
    • networkToken
    • ChargebackItem
    • SettlementRecord
    • CommandText
    • Card Not Present (CNP)
    • FraudAlertResponse
    • RawResponse
    • ErrorResponse
    • currency
    • Deferred
    • webhooksItem
    • ErrorResponse400
    • SettlementResponse
    • CommandColumns
    • extra_taxes
    • FraudAlertRecord
    • CardData
    • Amount
    • ErrorResponse401
    • ColumnItem
    • pos_details
    • ValidationError
    • LinkFailure
    • extraTaxes
    • ErrorResponse403
    • CommandDivider
    • card_details
    • enc_tlv
    • TransactionEvent
    • Country
    • payment_method
    • ErrorResponse500
    • CommandFeed
    • deferred
    • TransactionStatus
    • CommandSpace
    • contact_details
    • ReadingType
    • ContactDetails
    • CommandCut
    • sub_merchant
    • FailureReason
    • documentType
    • Subscription
    • CommandImage
    • metadata
    • EventTerminal
    • orderDetails
    • Language
    • TransactionSearchRequest
    • CommandQR
    • EventOperation
    • Shipping Address
    • payment_submethod
    • CommandBarcode
    • EventAmount
    • Billing-Address
    • PrintJobAccepted
    • EventExtraTaxes
    • SubscriptionUpdate
    • PrinterError
    • EventMetadata
    • threeDomainSecure
    • SubscriptionAdjustmentRequest
    • AmountWithTaxes
    • PrintJobStatus
    • PrintJobStatusRequest
    • product
    • webhooks
    • AmountCore
    • headers
    • ExtraTaxes
    • PrintWebhookPayload
    • Metadata
    • webhooksChargeback
    • citMit
    • AmountWithTip
    • TransactionSearchOnlineBody
    • TransactionSearchBody
    • binInfo
    • AmountWithOptionalTip
    • TransactionSearchLocalBody
    • messageFields
    • TransactionEvent_2
    • UnexpectedErrorResponse
    • FailureReason_2
    • transactionType
    • ExternalReferenceId
    • EventTerminal_2
    • ExternalSubscriptionId
    • EventOperation_2
    • EventAmount_2
    • EventExtraTaxes_2
    • EventMetadata_2
    • SettlementTicketRequest
    • network
    • 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 🇨🇱
Status
Soporte / Support
English
  • English
  • Español
  1. Appian - Submerchant Register

Release Notes


Release notes#

Discover the latest feature releases, product improvements and bug fixes of Appian - Submerchant Register.


Stay up to date with changes and updates to the batch submerchant onboarding endpoint POST /onboarding/v1/submerchants/batch in Colombia 🇨🇴.
We use the ISO 8601 standard (YYYY-MM-DD) for dates, and Semantic Versioning (MAJOR.MINOR.PATCH) for version numbers, increasing the:
1.
MAJOR version when we make incompatible API changes,
2.
MINOR version when we add functionality in a backward-compatible manner, and
3.
PATCH version when we make backward-compatible bug fixes.
NEW for new features.
IMPROVEMENTS for changes in existing functionality.
DEPRECATED for soon-to-be removed features.
REMOVED for now removed features.
FIX for any bug fixes.
SECURITY in case of vulnerabilities.

Latest#

1.2.0 - 2026-08-31#


NEW

🆕 Card Present and Card Not Present request variants#

Each item in the batch request now accepts one of two named request models. The documentation renders them as separate tabs (Card Present and Card Not Present) so you can pick the model that matches how the submerchant operates.
Key capabilities:
Card Present (CP): for submerchants that accept in‑person, terminal‑based payments. Includes the point‑of‑sale fields (usesKushkiPos, operationMode, emails, paymentOptions, paymentTypes, terminalCount, storeName, storeAddress).
Card Not Present (CNP): for submerchants that accept online / remote payments. Point‑of‑sale fields are not applicable and are omitted.
A single batch call can mix CP and CNP items — each array element is validated against the variant it declares.
INFO
The variant is selected per item. Send the fields that belong to the chosen model; fields from the other model are not accepted.

IMPROVEMENTS
IMPROVEMENTS — submerchantName and Soft Descriptor rules (per specification)
The length rule is corrected. It is not a fixed maximum of 18 characters:
Dynamic maximum length: MIN(18, 21 − length(PSP Prefix) − 1).
The system normalizes to uppercase and trims spaces.
The system builds the Soft Descriptor: PREFIX*SUBMERCHANT_NAME (max 21 characters). The client sends only submerchantName; the prefix and * are added by the system.
Allowed charset: A-Z, 0-9, &, -, and single spaces; at least one letter.
Not allowed: accents, Ñ, special characters, *, or double spaces. E.g. use PENA instead of PEÑA.
Rejected if, after normalization, it exceeds the dynamic maximum length or contains unsupported characters.
The specification for submerchantName has been updated to clarify character constraints, automatic normalization, and dynamic length rules for building Soft Descriptors:
Dynamic Length Limit: The effective maximum character length is calculated dynamically based on your PSP account's configured prefix using the formula:
Automatic Normalization: The input value is automatically converted to UPPERCASE and stripped of leading/trailing spaces (trim).
Allowed Characters: Uppercase letters (A–Z), numbers (0–9), ampersands (&), hyphens (-), and single spaces between words.
Letter Requirement: Must contain at least one letter (A–Z). Numeric-only strings (e.g., "12345") are rejected.
Prohibited Characters: Accents/tildes (Á, É), Ñ, asterisks (*), double spaces, and special symbols (@, #, $, %) are strictly prohibited.
Soft Descriptor: Do not include your PSP prefix, asterisks, or attempt to assemble the Soft Descriptor manually. The system automatically constructs the final descriptor as PREFIX*SUBMERCHANT NAME (maximum 21 total characters).
WARNING
Requests will fail with a BAD_REQUEST error if submerchantName exceeds the dynamic maximum character length configured for your PSP prefix, or if it contains forbidden characters (such as accents or Ñ). Please normalize text before sending (e.g., use PENA instead of PEÑA).

Previous release notes#

1.1.0 - 2026-01-01#


NEW

🆕 Batch submerchant onboarding#

Initial release of the batch submerchant onboarding endpoint POST /onboarding/v1/submerchants/batch in Colombia 🇨🇴, allowing multiple submerchants to be created in a single request.

Got a suggestion on this documentation? Contact us.
Modified at 2026-09-03 16:38:49
Previous
Appian - Submerchant Register
Next
Submerchant Validation in Batch
Built with