- 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
- Callback
- Device
- GiftCard
- Payment
- 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
- 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
- TenantWebhook
- 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
- Transaction
- Get payment channel storesGET
- Get payment method basic detailsGET
- Get payment method contentGET
- 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
SoftPayLicenceOrderDtoResponseDto
{
"data": {
"orderId": "string",
"orderNumber": "string",
"licenseName": "string",
"numberOfLicenses": 0,
"poNumber": "string"
},
"description": {
"code": "string",
"message": "string"
},
"narrative": {
"code": "string",
"message": "string"
}
}