LogoLogo
  • Transaction API
    • Overview
    • Authentication
    • Payment Methods
    • Integrations
      • POS (In-Store)
      • E-commerce
    • Payment Flows
      • Create a transaction
        • Examples for POS (In-Store)
          • Basic Payment Request
          • Payment request with products
          • Payment request with callback
          • Payment request with POS Data
          • SMS Payment Request
          • Email Payment Request
          • Payment request with invoice
          • Payment request with receipt generated by SensePass
          • Payment request with receipt generated by the POS
        • Examples for e-commerce
          • Basic Payment Request
          • iFrame Example
          • Payment request with products
          • Payment request with callback
          • Payment request with website custom data
          • SMS Payment Request
          • Email Payment Request
          • Payment request with invoice
          • Payment request with receipt generated by SensePass
          • Payment request with receipt generated by the e-commerce platform
      • Transaction status
      • Authorization
      • Tokenization
      • Subscription
        • Fetch a subscription
        • Update a subscription
        • Subscription callbacks
      • Cancel a pending transaction
      • Refund a transaction
      • Pay by Credit Card
      • Credit by Credit Card
      • Payment Commit
      • Update a Transaction
    • Other Flows
      • Tags Pairing
      • Receipts
      • Customer Input
      • Token Migration
      • Create Dynamic QR
    • Terminal Agent
      • Installation
      • Pairing
      • Usage
        • Synchronous Payment
        • Real-time product information update
        • Get Last Transaction Status
        • Get Device ID
    • Settlement
    • API Notifications
      • Socket.IO Websockets
      • Callback/Webhook
      • Post Message
    • Flow Charts
      • Payment Flow
      • Transaction Status Flow
    • SDK & iFrames
      • JavaScript UI SDK
        • API
        • Commit Transaction
        • Custom SDK Style
        • Simulator
        • Manual Capture (deprecated)
      • E-commerce iFrame
      • POS iFrame
      • Credit Card iFrame
    • Models
      • Receipts Model
      • Metadata Model
      • SDK Theme Config Model
      • SDK Credit Card Field Model
      • Invoice Model
      • Product Model
      • Payment Details Model
      • Receipt Notifications Model
      • Payment Commit Model
      • Confirmation Model
      • Settlement Model
      • Subscription Model
      • Transaction Page Model
      • Transaction Model
      • Customer Input Model
      • Settlement Report Model
      • Customer Shipping/Billing Details Model
      • Additional Data Model
    • SOAP and XML
      • SOAP
      • XML
    • Testing
    • Postman
  • Partner API
    • Models
      • Onboarding Model
      • Onboarding Configuration Pages
      • Onboarding Status Model
    • SDK & iFrames
      • Onboarding iFrame
    • Flows
      • Create onboarding
      • Get Onboarding Configuration Page
      • Onboarding status
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Partner API
  2. Models

Onboarding Status Model

Onboarding Status Model

This model is referenced in the response of #onboarding-status

field
type
description

uid

string

example: 52c8e55d-26dc-4935-9214-e3fccf6c8bcf The ID of the created onboarding

message

string

example: Merchant with this license id already exist

The error message in case the onboarding process failed

status

string

example: Approved

The status of the onboarding process, can be "Approved", "Failed", "Pending"

merchant

object

The merchant details in case the onboarding process succeeds (status is "Approved")

merchant.merchant_info

object

The merchant information inserted on the onboarding creation request

merchant.merchant_info.category

string

The merchant's category

merchant.merchant_info.city

string

The merchant's city

merchant.merchant_info.country

string

The merchant's country

merchant.merchant_info.email

string

The merchant's email

merchant.merchant_info.house_number

number

The merchant's house number

merchant.merchant_info.phone_number

string

The merchant's phone number

merchant.merchant_info.social_id

string

The merchant's EIN

merchant.merchant_info.name

string

The merchant's name

merchant.merchant_info.state

string

The merchant's state

merchant.merchant_info.street

string

The merchant's street

merchant.merchant_info.website

string

The merchant's website

merchant.merchant_info.locale

string

The merchant's locale (default is USA if nothing was filled)

merchant.merchant_owner_info

object

The merchant's owner information inserted on the onboarding creation request

merchant.merchant_owner_info.email

string

The merchant's owner's email

merchant.merchant_owner_info.name

string

The merchant's owner's name

merchant.merchant_owner_info.phone_number

string

The merchant's owner's phone number

merchant.merchant_owner_info.social_id

string

The merchant's owner's social id

merchant.active

boolean

If the merchant is active or not (true/false)

merchant.verified

boolean

If the merchant is verified or not (true/false)

merchant.status

object

The merchant's status object

merchant.status.uid

string

The merchant's status uinque identifier

merchant.status.name

string

The merchant's status name

merchant.uid

string

The merchant's uinque identifier

merchant.created

string

The merchant's created date

merchant.displayName

string

The merchant's display name (title)

merchant.logo

string

The merchant's logo

merchant.locations

array of objects

The merchant's locations (stores) array

merchant.locations.active

boolean

If the merchant's location is active or not (true/false)

merchant.locations.verified

boolean

If the merchant's location is verified or not (true/false)

merchant.locations.uid

string

If the merchant's location unique identifer

merchant.locations.created

string

If the merchant's location created date

merchant.locations.dispaly_name

string

If the merchant's location display name (title)

merchant.locations.number

string

If the merchant's location number

merchant.locations.apiKey

string

If the merchant's location api key

Last updated 2 years ago

Was this helpful?