Confirma Payment Platform
  1. PaymentChannel
Confirma Payment Platform
  • Developer Guide
  • Changelog
  • Basic Flow Guide
  • Viva Developers' Guide
  • Epassi Developers' Guide
  • Retain24 Developers' Guide
  • Resurs Developers' Guide
  • SoftPay Developers' Guide
  • Nexi Developers' Guide
  • v1
    • Authentication
      • Obtain a token
    • Callback
      • Redirect transaction flow
    • Device
      • Terminal device details
      • /{tenantCode}/v1/device/configuration
    • GiftCard
      • Get the available templates
      • Get template by Id
      • Create and Issue a Card
      • Top Up a Card
      • Get a Card
      • Validate a Card
      • Cancel a card
      • Cancel the last topup of the card
    • Payment
      • Create a new payment request
      • Marks the day end
    • PaymentChannel
      • Get payment channel merchants
        GET
      • Get available payment channels
        GET
      • Get configured payment channels
        GET
      • Get payment channel configuration requirements
        GET
      • Save payment channel configuration
        POST
      • Enable payment channel
        POST
      • Disable payment channel
        POST
      • Create a new account
        POST
      • Get payment channel stores
        GET
      • Get payment method basic details
        GET
      • Get payment method content
        GET
      • Get payment channel merchants
        GET
      • /{tenantCode}/v1/payment-channel/viva
        GET
    • Report
      • Get End Of Day Reports
      • Save End Of Day Reports
    • Transaction
      • Get customer receipt for a transaction
      • Get the transaction status
      • Cancel a transaction
      • Refund a transaction
      • Generic Refund (Without existing Transaction Id)
      • Update transaction status
      • Get merchant receipt for a transaction
      • Save a receipt for a transaction
    • Storage
      • Gets a secure update url for the storage
    • TenantWebhook
      • /{tenantCode}/v1/tenant-webhook/{provider}/viva/account
      • /{tenantCode}/v1/tenant-webhook/{provider}/viva/account
      • /{tenantCode}/v1/tenant-webhook/resurs/authorisation/transactions/{transactionUUID}
      • /{tenantCode}/v1/tenant-webhook/resurs/management/transactions/{transactionUUID}
    • Webhook
      • /v1/webhook/{provider}/viva/account
      • /v1/webhook/{provider}/viva/account
      • /v1/webhook/{provider}/viva/payment-created
      • /v1/webhook/{provider}/viva/payment-created
      • /v1/webhook/{provider}/viva/payment-failed
      • /v1/webhook/{provider}/viva/payment-failed
      • /v1/webhook/{provider}/viva/reversal-created
      • /v1/webhook/{provider}/viva/reversal-created
  1. PaymentChannel

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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sandbox.api.confirmapay.com//v1/payment-channel//configuration-requirements' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success
application/json
Payment channel configuration requirements
Body

Example
{
    "data": {
        "paymentChannelId": 1,
        "displayName": "string",
        "submissionType": "string",
        "fields": [
            {
                "fieldName": "string",
                "displayName": "string",
                "type": "string",
                "description": "string",
                "required": true,
                "isTenantConfiguration": true
            }
        ]
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}
🟢200Success
Modified at 2025-11-24 05:00:19
Previous
Get configured payment channels
Next
Save payment channel configuration
Built with