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
    • 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
      • 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 available payment channels
        • Get configured payment channels
        • Get payment channel configuration requirements
        • Save payment channel configuration
        • Enable payment channel
        • Disable payment channel
        • Create a new account
        • /{tenantCode}/v1/payment-channel/viva
        • Get payment channel stores
        • Get payment method basic details
        • Get payment method content
        • 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 a transaction
        • Generic Refund (Without existing Transaction Id)
        • Save a receipt for a transaction
        • Get merchant receipt for a transaction
        • Submit refund pin
      • 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
    • Schemas
      • v1
        • AdditionalPaymentMethods
        • SupportedPaymentChannel
        • ResponseDto
        • AdditionalPaymentMethods
        • SupportedPaymentChannelListResponseDto
        • AccountDetailsDto
        • AccountDetailsDtoListResponseDto
        • AddressDto
        • ApplicationMessageDto
        • AvailablePaymentChannelDetailDto
        • AvailablePaymentChannelDetailDtoListResponseDto
        • BooleanResponseDto
        • BrandColour
        • CancelIntentDto
        • CreateAccountRequestDto
        • CancelIntentDtoResponseDto
        • CreateAccountResponseDto
        • ClientCredentialTokenRequestDto
        • CreateAccountResponseDtoResponseDto
        • ClientOverrideDto
        • CollectionPromptChannel
        • CollectionPromptChannelDto
        • ContentDto
        • CountryCode
        • CreateGiftCardRequestDto
        • CreateNewAccountDto
        • CreateNewAccountResponseDto
        • CreateNewAccountResponseDtoResponseDto
        • CreatePaymentIntentDto
        • CurrencyCodes
        • CustomerDisplayType
        • CustomerInfoDto
        • WorldLineRefundOptions
        • CustomerType
        • DeviceConfiguration
        • DeviceSpecificationDto
        • DiscountDetailsDto
        • DiscountType
        • EndDayRequestDto
        • EndDayResponseDto
        • EndDayResponseDtoResponseDto
        • EpassiChannelOptions
        • ErrorResponseDto
        • GenericRefundPaymentIntentDto
        • GetCardDetailsRequestDto
        • TokenRequestDto
        • GiftCardDetailsDto
        • GiftCardDetailsDtoResponseDto
        • GiftCardPersonalizedMessageLengthDto
        • GiftCardPreviewDto
        • GiftCardStatus
        • GiftCardTemplateDetailsDto
        • GiftCardTemplateDetailsDtoListResponseDto
        • GiftCardTemplateDetailsDtoResponseDto
        • LegalLink
        • NetsBaxiChannelOptions
        • NetsBaxiCloudChannelOptions
        • NexiChannelOptions
        • OnsiteTerminalReportDto
        • NotificationChannel
        • OnsiteTerminalReportDtoResponseDto
        • NotificationOptions
        • ObjectResponseDto
        • OnboardCustomerRequestDto
        • OnboardCustomerResponseDto
        • OnboardCustomerResponseDtoResponseDto
        • OrderItemDto
        • OrderItemType
        • PaymentChannelType
        • POSType
        • PanEntryMode
        • PaymentAdditionalInfoDto
        • PaymentChannelAccountMetadata
        • PaymentChannelConfigurationFieldsDto
        • PaymentChannelConfigurationSchemaDto
        • PaymentChannelConfigurationSchemaDtoResponseDto
        • PaymentChannelMetaData
        • PaymentChannelMetaDataVerifoneVim
        • PaymentChannelMetaDataWestPay
        • PaymentChannelMetaDataWorldline
        • PaymentChannelOptionsDto
        • PaymentChannelOptionsForGenericRefundDto
        • PaymentChannelOptionsForRefundDto
        • PaymentFlowType
        • PaymentIntentDto
        • PaymentIntentDtoResponseDto
        • PaymentMethod
        • PaymentMethodBasicInfoResponseDto
        • PaymentMethodBasicInfoResponseDtoListResponseDto
        • PaymentMethodContentResponseDto
        • PaymentMethodContentResponseDtoResponseDto
        • PaymentMethodDto
        • PaymentStatus
        • PaymentSubStatus
        • PriceSignagePreview
        • PrintOnTerminalRequestDto
        • PrintOnTerminalResponseDto
        • PrintOnTerminalResponseDtoResponseDto
        • StoreDetailsDto
        • PrintResponseDto
        • StoreDetailsDtoListResponseDto
        • ReasonCode
        • ReceiptResponseDto
        • ReceiptResponseDtoResponseDto
        • ReceiptType
        • RefundPaymentIntentDto
        • RefundPaymentPinDto
        • ReportResponseDto
        • ReportResponseDtoResponseDto
        • ReportType
        • ResursChannelOptions
        • Retain24AccountOptions
        • Retain24ChannelOptions
        • SaveOnsiteTerminalReceiptDto
        • SaveOnsiteTerminalReportDto
        • MerchantsInformationDto
        • SoftPayChannelOptions
        • MerchantsInformationDtoListResponseDto
        • StringObjectDictionaryResponseDto
        • StringResponseDto
        • SupportedPaymentChannelDto
        • SupportedPaymentChannelDtoListResponseDto
        • TerminalDetailsResponseDto
        • TerminalDetailsResponseDtoResponseDto
        • TerminalStatus
        • Tip
        • TokenResponseDto
        • TokenResponseDtoResponseDto
        • TopupGiftCardRequestDto
        • TransactionStatusDto
        • TransactionType
        • TransactionStatusDtoResponseDto
        • UpdatePaymentChannelAccountDto
        • UpdateTransactionDto
        • VerifoneVimChannelOptions
        • VivaChannelOptions
        • VivaIsvSettingsDto
        • Void
        • WorldLineChannelOptions
        • PaymentChannelMetaDataWorldline
        • PrintOnTerminalRequestDto
        • PrintOnTerminalResponseDto
        • PrintOnTerminalResponseDtoResponseDto
        • Retain24ChannelOptions
        • WorldLineChannelOptions
        • WorldLineRefundOptions
        • PrintOnTerminalRequestDto

    Basic Flow Guide

    Payment Channel Flows
    Some payment channels might require a complex flow due to their different approaches in finalising payment. Therefore please refer payment channel specific documentation for better understanding of such flows.
    Debugging & Traceability
    All responses from ConfirmaPay Payment Platform will have a header "x-request-id" which will contain a GUID to help debug and trace issues. Ensure you store it to troubleshoot any issues in production on request basis.
    Initialise Payment
    1
    Create a new payment request
    Invoke a new payment request
    2
    Get the transaction status
    Check the status using the transactionId return from the previous request
    Cancel a transaction
    INFO
    Before the payment is collected.
    1
    Cancel a transaction
    Invoke transaction cancel process
    2
    Get the transaction status
    Check the status of the cancel request
    Refund a transaction
    1
    Refund a transaction
    Invoke transaction refund process
    2
    Get the transaction status
    Check the status of the refund request
    Modified at 2026-06-12 11:23:15
    Previous
    Confirma Optio Setup Guide (Onsite-Terminal)
    Next
    Changelog
    Built with