Onboard a customer for a payment channel

POST

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

This is the common endpoint to onboard a customer for a payment channel

Request

Path Params

Header Params

Body Params

application/json

Example

{
    "paymentChannelId": 1,
    "accountName": "string",
    "accountDisplayName": "string",
    "email": "string",
    "redirectUrl": "string",
    "brandColour": {
        "primaryColour": "string",
        "secondaryColour": "string",
        "tertiaryColour": "string"
    },
    "logoUrl": "string",
    "country": 4
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sandbox.api.confirmapay.com//v1/payment-channel//onboarding' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "paymentChannelId": 1,
    "accountName": "string",
    "accountDisplayName": "string",
    "email": "string",
    "redirectUrl": "string",
    "brandColour": {
        "primaryColour": "string",
        "secondaryColour": "string",
        "tertiaryColour": "string"
    },
    "logoUrl": "string",
    "country": 4
}'

Responses

🟢201 - Customer onboarded

application/json

Customer onboarded

Bodyapplication/json

Example

{
    "data": {
        "invitationUrl": "string",
        "accountId": "string"
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🟠409 - The customer is already connected, or the provider has not completed Viva onboarding

🔴500 - Internal server error occurred

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

/v1/webhook/{provider}/viva/reversal-created

Get payment channel onboarding status