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
  • API Interface
  • Get Onboarding status object by a onboarding uid
  • Schema

Was this helpful?

Export as PDF
  1. Partner API
  2. Flows

Onboarding status

Last updated 2 years ago

Was this helpful?

API for retrieving the current status of a given onboarding.

API Interface

Get Onboarding status object by a onboarding uid

GET /api/partners/onboarding/{onboarding_uid}

Path Parameters

Name
Type
Description

onboarding_uid*

String

Onboarding unique identifier

Headers

Name
Type
Description

Authorization

String

Auth token from auth/token API

See Onboarding Status entity schema: 

{
    "uid": "06a6abb6-5da9-47c0-a35f-dd8db215a8e1",
    "status": "Approved",
    "message": null,
    "merchant": {
        "merchant_info": {
            "category": "ski",
            "city": "abrotzo",
            "country": "Italy",
            "email": "merchant2@email.com",
            "house_number": 100,
            "phone_number": "19148759682",
            "social_id": "89485712",
            "name": "ski and snowboard inc",
            "state": "my state",
            "street": "very goood thing",
            "website": null,
            "locale": "USA"
        },
        "merchant_owner_info": {
            "email": "contact@me.com",
            "name": "moshe israel",
            "phone_number": "1555888999",
            "social_id": null
        },
        "active": true,
        "verified": false,
        "status": {
            "uid": "2",
            "name": "Approved"
        },
        "uid": "27fd4624-2fd5-4b31-ad29-67f1a85e5ec3",
        "created": "2023-01-23T09:26:02.548Z",
        "displayName": "ski&snowboard",
        "logo": null,
        "locations": [
            {
                "active": true,
                "verified": false,
                "uid": "eca844e7-cc30-438c-ac80-107cbb837cb9",
                "created": "2023-01-23T09:26:02.827Z",
                "display_name": "my store",
                "number": "1",
                "apiKey": "usbs5vnwffp3v8on2zrqld2gd60boj2048ixh9ub0zbkwk1pflobxybn"
            }
        ]
    }
}
{
    // Response
}
{
    // Response
}

Schema

Full Onboarding Status Entity schema:

# Onboarding-status-entity
# Onboarding-status-entity