Confirma Payment Platform
    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
    • Worldline 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
      • 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
        • Save a receipt for a transaction
        • Get merchant 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
    • Schemas
      • v1
      • AdditionalPaymentMethods
      • SupportedPaymentChannel
      • ResponseDto
      • AdditionalPaymentMethods
      • SupportedPaymentChannelListResponseDto
      • ApplicationMessageDto
      • BooleanResponseDto
      • BrandColour
      • CancelIntentDto
      • CancelIntentDtoResponseDto
      • ClientOverrideDto
      • CollectionPromptChannel
      • CollectionPromptChannelDto
      • CreateAccountRequestDto
      • CreateAccountResponseDto
      • CreateAccountResponseDtoResponseDto
      • CurrencyCodes
      • CustomerDisplayType
      • CustomerInfoDto
      • DeviceConfiguration
      • DeviceSpecificationDto
      • EndDayRequestDto
      • ErrorResponseDto
      • GenericRefundPaymentIntentDto
      • POSType
      • PanEntryMode
      • PaymentIntentDto
      • PaymentAdditionalInfoDto
      • PaymentChannelType
      • PaymentChannelMetaData
      • PaymentChannelOptionsForGenericRefundDto
      • PaymentChannelOptionsForRefundDto
      • PaymentIntentDtoResponseDto
      • PaymentMethod
      • PaymentMethodDto
      • PaymentStatus
      • PrintResponseDto
      • ReasonCode
      • RefundPaymentIntentDto
      • ReportResponseDto
      • ReportResponseDtoResponseDto
      • ReportType
      • SaveOnsiteTerminalReportDto
      • TokenRequestDto
      • 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
      • PaymentChannelOptionsDto
      • PaymentChannelOptionsDto
      • ReceiptResponseDto
      • ReceiptResponseDtoResponseDto
      • ReceiptType
      • SaveOnsiteTerminalReceiptDto
      • VivaIsvSettingsDto
      • GetCardDetailsRequestDto
      • CustomerType
      • OrderItemDto
      • OrderItemType
      • PaymentFlowType
      • PaymentSubStatus
      • ResursChannelOptions
      • CountryCode
      • LegalLink
      • PaymentMethodBasicInfoResponseDto
      • PaymentMethodBasicInfoResponseDtoListResponseDto
      • PaymentMethodContentResponseDto
      • PaymentMethodContentResponseDtoResponseDto
      • PriceSignagePreview
      • StoreDetailsDto
      • StoreDetailsDtoListResponseDto
      • AddressDto
      • AvailablePaymentChannelDetailDto
      • AvailablePaymentChannelDetailDtoListResponseDto
      • PaymentChannelConfigurationFieldsDto
      • PaymentChannelConfigurationSchemaDto
      • PaymentChannelConfigurationSchemaDtoResponseDto
      • PaymentChannelMetaDataVerifoneVim
      • StringObjectDictionaryResponseDto
      • StringResponseDto
      • VerifoneVimChannelOptions
      • MerchantsInformationDto
      • MerchantsInformationDtoListResponseDto
      • SoftPayChannelOptions
      • Tip
      • SupportedPaymentChannelDto
      • SupportedPaymentChannelDtoListResponseDto
      • Void
      • NexiChannelOptions
      • PaymentChannelMetaDataWorldline
      • PaymentChannelMetaDataWorldline
      • PrintOnTerminalRequestDto
      • PrintOnTerminalRequestDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • PrintOnTerminalResponseDtoResponseDto
      • Retain24ChannelOptions
      • Retain24ChannelOptions
      • WorldLineChannelOptions
      • WorldLineChannelOptions
      • WorldLineRefundOptions
      • WorldLineRefundOptions
      • EndDayResponseDto
      • PrintOnTerminalRequestDto

    Retain24 Developers' Guide

    Retain24 Developer's Guide#

    Setup Instructions
    Sandbox
    Production
    1.
    Email your request to the support team to obtain sandbox credentials to use Obtain a token.

    💡
    If your tenant has multiple accounts, you can obtain multiple cerrificates from Retain24 unique for each account, and forward it to the support team with account identification.
    Now you are good to create a card or payment request and start integrating.
    1. Gift Card Management
    2. Payments Flow
    Modified at 2026-02-12 11:17:21
    Previous
    Epassi Developers' Guide
    Next
    Resurs Developers' Guide
    Built with