1. Payment Providers
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
    • Get payment channel onboarding status
    • Synchronise payment channel onboarding status
    • Create a new account
    • Get payment channel accounts
    • Update payment channel account
    • Delete payment channel account
    • Get payment method basic details
    • Get payment method content
  • 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. Payment Providers

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-06-01 02:57:12
Previous
Epassi Developers' Guide
Next
Resurs Developers' Guide
Built with