1. PaymentChannel
Confirma Payment Platform
  • Developer Guide
  • Confirma Optio Setup Guide (Onsite-Terminal)
  • Basic Flow Guide
  • Changelog
  • Payment Providers
    • Viva Developers' Guide
    • Epassi Developers' Guide
    • Retain24 Developers' Guide
    • Resurs Developers' Guide
    • SoftPay Developers' Guide
    • Nets Baxi Developers' Guide
    • Worldline Developers' Guide
    • Nexi Developers' Guide
    • Verifone Vim Developers' Guide
    • Nets Baxi Cloud Developers' Guide
    • Verifone Cloud Developer's Guide
    • Westpay Cloud Developers' Guide
    • Swish Developer's Guide
    • Vipps MobilePay Developer's Guide
  • v1
    • Authentication
      • Obtain a token
    • Callback
      • Redirect transaction flow
    • Device
      • /{tenantCode}/v1/device/configuration
      • Terminal device details
      • Print receipt on Terminal
      • Print receipt on Terminal
      • Print receipt status on Terminal
    • 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
      • Perform reconciliation
    • PaymentChannel
      • Get payment channel merchants
      • Create a new account
      • Get available payment channels
      • /{tenantCode}/v1/payment-channel/viva
      • Get configured payment channels
      • Get payment channel configuration requirements
      • Save payment channel configuration
      • Enable payment channel
      • Disable payment channel
      • Get payment channel merchants
    • Report
      • Get End Of Day Reports
      • Save End Of Day Reports
      • Get End Of Day Reports by reference
      • Get Last End Of Day Report
    • Transaction
      • Get customer receipt for a transaction
      • Get the transaction status
      • Cancel a transaction
      • Refund Transaction Without Transaction ID, not linked
      • Save a receipt for a transaction
      • Get merchant receipt for a transaction
      • Submit refund pin
      • Release a terminal occupied by a pending transaction
      • Get the current processing transaction for a terminal
    • 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
  • PaymentChannel
    • Onboard a customer for a payment channel
      POST
    • Get payment channel onboarding status
      GET
    • Synchronise payment channel onboarding status
      POST
    • Create a new account
      POST
    • Get payment channel accounts
      GET
    • Update payment channel account
      PUT
    • Delete payment channel account
      DELETE
    • Get payment method basic details
      GET
    • Get payment method content
      GET
  • Transaction
    • Update transaction status
  • Get payment channel stores
    GET
  • Get payment method basic details
    GET
  • Get payment method content
    GET
  • Refund full amount/partial linked to previous transactions.
    POST
  • Schemas
    • v1
      • AdditionalPaymentMethods
      • SupportedPaymentChannel
      • ResponseDto
      • SupportedPaymentChannelListResponseDto
      • CreateAccountRequestDto
      • CreateAccountResponseDto
      • CreateAccountResponseDtoResponseDto
      • WorldLineRefundOptions
      • TokenRequestDto
      • OnsiteTerminalReportDto
      • OnsiteTerminalReportDtoResponseDto
      • StoreDetailsDto
      • StoreDetailsDtoListResponseDto
      • SaveOnsiteTerminalReportDto
      • MerchantsInformationDto
      • MerchantsInformationDtoListResponseDto
      • PaymentChannelMetaDataWorldline
      • PrintOnTerminalRequestDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • Retain24ChannelOptions
      • WorldLineChannelOptions
      • WorldLineRefundOptions
      • PrintOnTerminalRequestDto
    • ApiClientDto
    • ApiClientDtoListResponseDto
    • ApiClientDtoResponseDto
    • ConfigurablePaymentChannelDto
    • ConfigurablePaymentChannelDtoListResponseDto
    • ConnectResursPartnerDto
    • ConnectSoftPayPartnerDto
    • CreateApiClientDto
    • PaymentChannelOptionsDto
    • NetsBaxiCloudChannelOptions
    • AccountDetailsDto
    • AccountDetailsDtoListResponseDto
    • CreateNewAccountDto
    • CreateNewAccountResponseDto
    • CreateNewAccountResponseDtoResponseDto
    • EndDayResponseDtoResponseDto
    • OnboardCustomerRequestDto
    • OnboardCustomerResponseDto
    • OnboardCustomerResponseDtoResponseDto
    • PaymentChannelAccountMetadata
    • PaymentChannelMetaDataWestPay
    • RefundPaymentPinDto
    • Retain24AccountOptions
    • UpdatePaymentChannelAccountDto
    • ApplicationMessageDto
    • BooleanResponseDto
    • BrandColour
    • CancelIntentDto
    • CancelIntentDtoResponseDto
    • ClientOverrideDto
    • CollectionPromptChannel
    • CollectionPromptChannelDto
    • CurrencyCodes
    • CustomerDisplayType
    • CustomerInfoDto
    • DeviceConfiguration
    • DeviceSpecificationDto
    • EndDayRequestDto
    • ErrorResponseDto
    • GenericRefundPaymentIntentDto
    • POSType
    • PanEntryMode
    • PaymentAdditionalInfoDto
    • PaymentIntentDto
    • PaymentIntentDtoResponseDto
    • PaymentMethod
    • PaymentMethodDto
    • PaymentStatus
    • PrintResponseDto
    • ReasonCode
    • RefundPaymentIntentDto
    • ReportResponseDto
    • ReportResponseDtoResponseDto
    • ReportType
    • TokenResponseDto
    • TokenResponseDtoResponseDto
    • TransactionStatusDto
    • TransactionStatusDtoResponseDto
    • UpdateTransactionDto
    • VivaChannelOptions
    • TerminalDetailsResponseDto
    • TerminalStatus
    • TransactionType
    • TerminalDetailsResponseDtoResponseDto
    • CreatePaymentIntentDto
    • ContentDto
    • CreateGiftCardRequestDto
    • DiscountDetailsDto
    • DiscountType
    • EpassiChannelOptions
    • GiftCardDetailsDto
    • GiftCardDetailsDtoResponseDto
    • GiftCardPersonalizedMessageLengthDto
    • GiftCardPreviewDto
    • GiftCardStatus
    • GiftCardTemplateDetailsDto
    • GiftCardTemplateDetailsDtoListResponseDto
    • GiftCardTemplateDetailsDtoResponseDto
    • NotificationChannel
    • NotificationOptions
    • TopupGiftCardRequestDto
    • ObjectResponseDto
    • ReceiptResponseDto
    • ReceiptResponseDtoResponseDto
    • ReceiptType
    • SaveOnsiteTerminalReceiptDto
    • VivaIsvSettingsDto
    • GetCardDetailsRequestDto
    • CustomerType
    • OrderItemDto
    • OrderItemType
    • PaymentFlowType
    • PaymentSubStatus
    • ResursChannelOptions
    • CountryCode
    • LegalLink
    • PaymentMethodBasicInfoResponseDto
    • PaymentMethodBasicInfoResponseDtoListResponseDto
    • PaymentMethodContentResponseDto
    • PaymentMethodContentResponseDtoResponseDto
    • PriceSignagePreview
    • AddressDto
    • AvailablePaymentChannelDetailDto
    • AvailablePaymentChannelDetailDtoListResponseDto
    • PaymentChannelConfigurationFieldsDto
    • PaymentChannelConfigurationSchemaDto
    • PaymentChannelConfigurationSchemaDtoResponseDto
    • PaymentChannelMetaData
    • PaymentChannelMetaDataVerifoneVim
    • PaymentChannelOptionsForGenericRefundDto
    • PaymentChannelOptionsForRefundDto
    • StringObjectDictionaryResponseDto
    • StringResponseDto
    • VerifoneVimChannelOptions
    • SoftPayChannelOptions
    • Tip
    • SupportedPaymentChannelDto
    • SupportedPaymentChannelDtoListResponseDto
    • Void
    • AdditionalPaymentMethods
    • PaymentChannelMetaDataWorldline
    • PrintOnTerminalRequestDto
    • PrintOnTerminalResponseDto
    • PrintOnTerminalResponseDtoResponseDto
    • Retain24ChannelOptions
    • NexiChannelOptions
    • EndDayResponseDto
    • ClientCredentialTokenRequestDto
    • NetsBaxiChannelOptions
    • WorldLineChannelOptions
    • PaymentChannelSection
    • PaymentChannelType
    • CreateSoftPayAppCredentialDto
    • CreateSoftPayLicenceOrderDto
    • CreateSoftPayMerchantDto
    • CreateSoftPayStoreDto
    • CreateSoftPayTerminalDto
    • OptioLogInstallationResultDto
    • OptioLogStorageLocationDto
    • OptioLogUploadRequestDto
    • OptioLogUploadResponseDto
    • OptioLogUploadResponseDtoResponseDto
    • OptioLogUploadStatus
    • PaymentChannelConfigurationDto
    • PaymentChannelConfigurationDtoResponseDto
    • PaymentChannelPropertyDto
    • PropertySize
    • PropertyType
    • ReleaseTerminalRequestDto
    • ReleaseTerminalResponseDto
    • ReleaseTerminalResponseDtoResponseDto
    • ReduceSoftPayLicencesDto
    • ReplaceSoftPayTerminalDeviceDto
    • RequestResursStoreDto
    • TerminalReportRequestDto
    • ResursPartnerStatusDto
    • ResursPartnerStatusDtoResponseDto
    • ResursStoreDto
    • ResursStoreDtoListResponseDto
    • ResursStoreDtoResponseDto
    • ResursStoreOverviewDto
    • ResursStoreOverviewDtoResponseDto
    • ResursStoreRequestResultDto
    • ResursStoreRequestResultDtoResponseDto
    • SaveResursStoreDto
    • SoftPayAppCredentialDeliveryDto
    • SoftPayAppCredentialDeliveryDtoResponseDto
    • SoftPayAppCredentialDto
    • SoftPayAppCredentialDtoListResponseDto
    • SoftPayLicenceOrderDto
    • SoftPayLicenceOrderDtoResponseDto
    • SoftPayLicenceOverviewDto
    • SoftPayLicenceOverviewDtoResponseDto
    • SoftPayMerchantDto
    • SoftPayMerchantDtoResponseDto
    • SoftPayOverviewDto
    • SoftPayOverviewDtoResponseDto
    • SoftPayPartnerCredentialsDto
    • SoftPayPartnerCredentialsDtoResponseDto
    • SoftPayPartnerStatusDto
    • SoftPayPartnerStatusDtoResponseDto
    • SoftPayProcessorTerminalDto
    • SoftPayProcessorTerminalInputDto
    • SoftPayProcessorTerminalMetadata
    • SoftPayStoreDto
    • SoftPayStoreDtoListResponseDto
    • SoftPayStoreDtoResponseDto
    • SoftPayStoreMetadata
    • SoftPayTerminalDto
    • SoftPayTerminalDtoListResponseDto
    • SoftPayTerminalDtoResponseDto
    • SoftPayTerminalMetadata
    • UpdateSoftPayMerchantDto
    • UpdateSoftPayPartnerTerminalIdDto
    • UpdateSoftPayStoreDto
    • VivaConnectedAccountMetadata
    • VivaCustomerOnboardingStatusDto
    • VivaCustomerOnboardingStatusDtoResponseDto
    • VivaIsvWebhookRegistrationDto
    • VivaProviderOnboardingStatusDto
    • VivaProviderOnboardingStatusDtoResponseDto
  1. PaymentChannel

Create a new account

POST
/{tenantCode}/v1/payment-channel/{paymentChannelId}/accounts
This is the common endpoint to create an account for a payment channel

Request

Path Params

Header Params

Body Params
application/json

Example
{
    "name": "string",
    "accountId": "string",
    "paymentChannelId": 1,
    "country": 4,
    "retain24Options": {
        "accountReferenceId": "string",
        "certificateBase64": "string",
        "certificatePassword": "string",
        "clientUsername": "string"
    }
}

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 'https://sandbox.api.confirmapay.com//v1/payment-channel//accounts' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "accountId": "string",
    "paymentChannelId": 1,
    "country": 4,
    "retain24Options": {
        "accountReferenceId": "string",
        "certificateBase64": "string",
        "certificatePassword": "string",
        "clientUsername": "string"
    }
}'

Responses

🟢201 - Account created
application/json
Account created
Bodyapplication/json

Example
{
    "data": {
        "id": "string",
        "name": "string",
        "accountReferenceId": "string",
        "paymentChannelId": 1,
        "metadata": {
            "softPay": {
                "merchantId": "string",
                "storeId": "string",
                "partnerStoreId": "string",
                "state": "string",
                "addressLine1": "string",
                "addressLine2": "string",
                "zipCode": "string",
                "city": "string",
                "cardAcceptorCountryCode": "string",
                "defaultCurrencyCode": "string",
                "businessRegNo": "string",
                "phone": "string",
                "timeZone": "string",
                "netsTofNumber": "string",
                "isDemo": true,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "lastSyncedAt": "2019-08-24T14:15:22.123Z",
                "terminals": [
                    {
                        "terminalId": "string",
                        "shortTerminalId": "string",
                        "appId": "string",
                        "type": "string",
                        "state": "string",
                        "deviceBrand": "string",
                        "deviceSerialNumber": "string",
                        "partnerTerminalId": "string",
                        "takenAt": "string",
                        "releasedAt": "string",
                        "suspendedAt": "string",
                        "lastOnline": "string",
                        "createdAt": "2019-08-24T14:15:22.123Z",
                        "lastSyncedAt": "2019-08-24T14:15:22.123Z",
                        "processorTerminals": [
                            {
                                "processorType": "string",
                                "state": "string",
                                "onlineTerminalId": "string",
                                "onlineMerchantId": "string",
                                "merchantCategoryCode": "string",
                                "cardAcceptorNameLocation": "string"
                            }
                        ]
                    }
                ]
            },
            "retain24AccountReferenceId": "string",
            "retain24CertificateThumbprint": "string",
            "retain24CertificateSubject": "string",
            "retain24CertificateIssuer": "string",
            "retain24CertificateActivationDateInUtc": "2019-08-24T14:15:22.123Z",
            "retain24CertificateExpiryDateInUtc": "2019-08-24T14:15:22.123Z",
            "viva": {
                "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
                "isDemo": true,
                "email": "string",
                "merchantId": "string",
                "verified": true,
                "acquiringEnabled": true,
                "connectedAt": "2019-08-24T14:15:22.123Z",
                "lastEventTypeId": 0,
                "lastMessageId": "string",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            }
        }
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}
🟠400 - Account name is required
🟠400 - Account display name is required
🟠400 - Redirect url is required
🟠400 - Logo url is required
🔴500 - Internal server error occurred
Modified at 2026-10-29 04:44:15
Previous
Synchronise payment channel onboarding status
Next
Get payment channel accounts
Built with