Get payment channel configuration requirements

GET

/{tenantCode}/v1/payment-channel/{paymentChannelId}/configuration-requirements

This is the common endpoint to get payment channel configuration requirements

Request

Path Params

Header Params

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//configuration-requirements' \
--header 'Authorization: Bearer <token>'

Responses

🟢200 - Payment channel configuration requirementsSuccess

application/json

Payment channel configuration requirements

Bodyapplication/json

Example

{
    "data": {
        "paymentChannelId": 1,
        "displayName": "string",
        "submissionType": "string",
        "fields": [
            {
                "fieldName": "string",
                "displayName": "string",
                "type": "string",
                "description": "string",
                "required": true,
                "isTenantConfiguration": true,
                "location": "string"
            }
        ]
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🔴500 - Internal server error occurredSuccess

Modified at 2026-06-08 12:48:43

Get configured payment channels

Save payment channel configuration