Get configured payment channels

GET

/{tenantCode}/v1/payment-channel

This is the common endpoint to get configured payment channels

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.api.confirmapay.com//v1/payment-channel' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Configured payment channels

Body

Example

{
    "data": [
        {
            "id": 1,
            "name": "string",
            "paymentMethods": [
                {
                    "id": 0,
                    "name": "string",
                    "collectionPromptChannels": [
                        {
                            "id": 0,
                            "name": "string",
                            "prerequisites": [
                                "string"
                            ],
                            "fields": [
                                {
                                    "fieldName": "string",
                                    "displayName": "string",
                                    "type": "string",
                                    "description": "string",
                                    "required": true,
                                    "isTenantConfiguration": true
                                }
                            ]
                        }
                    ]
                }
            ],
            "enabled": true
        }
    ],
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🟢200Success

Modified at 2025-11-24 05:00:19

Get available payment channels

Get payment channel configuration requirements