Get payment channel onboarding status

GET

/{tenantCode}/v1/payment-channel/{paymentChannelId}/onboarding

Returns the stored Viva connected account onboarding state of this tenant

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200 - Onboarding status

application/json

Onboarding status

Bodyapplication/json

Example

{
    "data": {
        "isDemo": true,
        "status": "string",
        "accountId": "string",
        "merchantId": "string",
        "email": "string",
        "invitationUrl": "string",
        "invitedAt": "2019-08-24T14:15:22.123Z",
        "verified": true,
        "acquiringEnabled": true,
        "connectedAt": "2019-08-24T14:15:22.123Z",
        "lastSyncedAt": "2019-08-24T14:15:22.123Z",
        "providerConfigured": true,
        "canOnboard": true
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🟠400 - Payment channel does not support onboarding

🔴500 - Internal server error occurred

Modified at 2026-10-29 04:44:15

Onboard a customer for a payment channel

Synchronise payment channel onboarding status