Webhook
Copy Page
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
POST
/v1/webhook/{provider}/viva/account
GET
/v1/webhook/{provider}/viva/payment-created
POST
/v1/webhook/{provider}/viva/payment-created
GET
/v1/webhook/{provider}/viva/payment-failed
POST
/v1/webhook/{provider}/viva/payment-failed
GET
/v1/webhook/{provider}/viva/reversal-created
POST
/v1/webhook/{provider}/viva/reversal-created
GET
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
Webhook
Copy Page
/v1/webhook/{provider}/viva/reversal-created
GET
/v1/webhook/{provider}/viva/reversal-created
Try it
Run in Apidog
Run in Apidog
Request
Path Params
Generate Code
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
cURL-Windows
Httpie
wget
PowerShell
curl
--location
'https://sandbox.api.confirmapay.com/v1/webhook//viva/reversal-created'
Responses
🟢
200
OK
OK
This response does not have a body.
Modified atÂ
2026-06-08 12:48:44
Previous
/v1/webhook/{provider}/viva/reversal-created
Next
Onboard a customer for a payment channel